# MID

## HED

[add component documentation]

### LAS

[add component documentation]

#### COM

[add component documentation]

##### CAM

[add component documentation]

###### CAM1

Instance id: | HED_LAS_COM/CAM/CAM1
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_LAS_MOTOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM2

Instance id: | HED_LAS_COM/CAM/CAM2
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_LAS_MOTOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM3

Instance id: | HED_LAS_COM/CAM/CAM3
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_LAS_MOTOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM4

Instance id: | HED_LAS_COM/CAM/CAM4
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM5

Instance id: | HED_LAS_COM/CAM/CAM5
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM6

Instance id: | HED_LAS_COM/CAM/CAM6
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### CAM9

Instance id: | HED_LAS_COM/CAM/CAM9
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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

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
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### MOTOR

[add component documentation]

###### MIRR1_H

###### MIRR1_V

###### MIRR2_H

###### MIRR2_V

###### MIRR3_H

###### MIRR3_V

###### MIRR9E_H

###### MIRR9E_V

### XTD6

[add component documentation]

#### PPL

[add component documentation]

##### DOOCS

[add component documentation]

###### PPLASER_PULSER

## LAS

[add component documentation]

### PPL

[add component documentation]

#### SA2XT

[add component documentation]

##### DCTRL

[add component documentation]

###### 5V_OUTPUT_1

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Scenes: | Macro_EXP_PPL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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

###### 5V_OUTPUT_2

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

## LA2

[add component documentation]

### LAS

[add component documentation]

#### PPL

[add component documentation]

##### ADC

[add component documentation]

###### 1

Instance id: | LA2_LAS_PPL/ADC/1
Class id: | FastAdc
Host: | mid-rr-sys-con-11
Class documentation:
| FastAdc
Alias: | mid-rr-sys-con-11
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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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

##### CTRL

[add component documentation]

###### TRGDLY

## HW

### MID

#### EXP

##### SAM

###### MOTOR

LOHEX
U
V
Y
Z
SSHEX
U
V
Y

Instance id: | HW_MID_EXP_SAM_MOTOR_SSHEX_Y
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM_hexapods, HW_MID_EXP_SAM_MOTOR_SSHEX_Y|motorScene, 2548, 2718_2616, 2718_2616, Macro_EXP_PPL, 2548_xpcs, 2929_xpcs
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

Z

## SA2

### EXH

#### PKW

##### SWITCH

###### FL_A05_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A05_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A05_F1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A05_F1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A05_F2_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A05_F2_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A05_F2_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A05_F2_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A07_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A07_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A07_F1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A07_F1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A07_F2_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A07_F2_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A07_F2_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A07_F2_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT3

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT4

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT4
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT5

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT5
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_CB1_OUT6

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_CB1_OUT6
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_F1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_F1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_F2_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_F2_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A08_F2_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A08_F2_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT3

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT4

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT4
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT5

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT5
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB1_OUT6

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB1_OUT6
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB2_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB2_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB2_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB2_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A10_CB2_OUT3

Instance id: | SA2_EXH_PKW/SWITCH/FL_A10_CB2_OUT3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A13_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A13_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A13_F1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A13_F1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A23_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A23_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A25_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A25_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A25_F1_OUT2

Instance id: | SA2_EXH_PKW/SWITCH/FL_A25_F1_OUT2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_A26_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_A26_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FL_SW_F1_OUT1

Instance id: | SA2_EXH_PKW/SWITCH/FL_SW_F1_OUT1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TSENS

###### TS_A05_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A05_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A05_F1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A05_F2_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F2_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A05_F2_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F2_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A05_F2_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A05_F2_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F2_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F2_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F2_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F2_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A07_F2_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A07_F2_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT3

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT4

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT5

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_CB1_OUT6

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_CB1_OUT6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F2_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F2_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F2_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F2_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A08_F2_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A08_F2_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT3

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT4

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT5

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB1_OUT6

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB1_OUT6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB2_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB2_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB2_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB2_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB2_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB2_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A10_CB2_OUT3

Instance id: | SA2_EXH_PKW/TSENS/TS_A10_CB2_OUT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A13_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A13_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A13_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A13_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A13_F1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A13_F1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A23_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A23_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A23_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A23_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A25_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A25_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A25_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A25_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A25_F1_OUT2

Instance id: | SA2_EXH_PKW/TSENS/TS_A25_F1_OUT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A26_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_A26_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_A26_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_A26_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_SW_F1_IN

Instance id: | SA2_EXH_PKW/TSENS/TS_SW_F1_IN
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS_SW_F1_OUT1

Instance id: | SA2_EXH_PKW/TSENS/TS_SW_F1_OUT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

### SYS

#### EPS2MPS

##### DOOCS

###### POD_MID

Instance id: | SA2_SYS_EPS2MPS/DOOCS/POD_MID
Class id: | DoocsPulseKicker
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | test, PUMA_TEST, 2548, 2718_2616, 2718_2616, Macro_EXP_PPL, 2548_xpcs
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

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
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- eventsTrigger:
    Number of fired Trigger
- setBunches:
    This slot will set given number of bunches to DOOCS and will stay at a given number
- acquisitionTime:
    The Interval between requesting bunches and then setting it to zero.
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- updateInterval:
    Polling Interval to get updated values from DOOCS
- start:
    This slot will set given number of Bunches to DOOCS and after waiting interval(i.e. acquisitionTime) it will set back to zero
- stop:
    This slot will only set zero to DOOCS if start command is not finished. This command will be void if start commands was not executed or was already completed
- beamLine:
    Beam Line

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

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

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

### XTD1

#### ATT

##### PNACT

###### A1

Instance id: | SA2_XTD1_ATT/PNACT/A1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A3

Instance id: | SA2_XTD1_ATT/PNACT/A3
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A4

Instance id: | SA2_XTD1_ATT/PNACT/A4
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A5

Instance id: | SA2_XTD1_ATT/PNACT/A5
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A6

Instance id: | SA2_XTD1_ATT/PNACT/A6
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A7

Instance id: | SA2_XTD1_ATT/PNACT/A7
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

###### A8

Instance id: | SA2_XTD1_ATT/PNACT/A8
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

##### MDL

[add component documentation]

###### MAIN

#### CRL

##### MDL

###### CRL

Instance id: | SA2_XTD1_CRL/MDL/CRL
Class id: | CompoundRefractiveLens
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/compoundRefractiveLens
Last modified: | 2021-05-27T15:24:47.000+02:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.3.0-2.11.0
Deployment tag: | 1.3.0-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- interlocks:
    Properties of the interlock sensors.

Release History
1.3.0-2.11.0

Created: | 2021-05-27T15:25:24.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.4-2.10.0

Created: | 2021-05-26T15:39:43.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor use EPS logic

1.2.3-2.10.0

Created: | 2020-11-23T18:18:18.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T17:04:07.000+01:00
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T15:04:45.000+01:00
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T13:21:31.000+01:00
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T16:08:12.000+01:00
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T14:50:06.000+01:00
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T11:54:51.000+01:00
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T22:49:17.000+02:00
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T11:58:18.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T16:56:11.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T13:46:49.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T13:28:02.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T20:01:36.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T16:52:56.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### CHAM_AX

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

#### IMGFEL

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | mid-rr-sys-con-11
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

Image Processor

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

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
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- 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.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
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-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
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-10T14:13:22.000+01:00
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-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
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-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

#### IMGSR

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGSR/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | mid-rr-sys-con-11
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

Image Processor

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

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
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- 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.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
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-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
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-10T14:13:22.000+01:00
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-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
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-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

#### XGM

###### DOOCS

Instance id: | SA2_XTD1_XGM/XGM/DOOCS
Class id: | DoocsXGM
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Projects: | MID_DOOCS_PROXIES
Scenes: | test, correlation, sdklh, MID_OPT_MONO/CAM/Imager_Main, MID_AUXT2_IMGPI_position, build, Cam1, Imager_Main_DES, SA2_XTD1_XGM_OVERVIEW, 2548, 2718_2616, 2718_2616, Macro_EXP_PPL, 2548_xpcs, MID_MAIN, UserMain, UsersBeamParameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

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
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- reset:
    Resets the device in case of an error
- location:
    Location identifies DOOCS server like XGM.2643.T9
- pollingInterval:
    Polling Interval to get updated values from DOOCS.
- controlData:
    Slow data parameters

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

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

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

### XTD6

#### IMGPII45-1

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | mid-rr-sys-con-11
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

Image Processor

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

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
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- 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.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
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-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
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-10T14:13:22.000+01:00
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-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
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-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

#### IMGPII45-2

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | mid-rr-sys-con-11
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

Image Processor

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

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
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- 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.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
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-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
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-10T14:13:22.000+01:00
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-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
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-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

#### MIRR-1

##### MOTOR

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

#### MIRR-2

##### MOTOR

###### BENDER

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

#### MIRR-3

##### MOTOR

###### HMTX

#### VAC

##### IPUMP

###### P21280I

Instance id: | SA2_XTD6_VAC/IPUMP/P21280I
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### P21330I

Instance id: | SA2_XTD6_VAC/IPUMP/P21330I
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### V21100M

Instance id: | SA2_XTD6_VAC/VALVE/V21100M
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- 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.
- 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
- 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.
- 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

##### GAUGE

[add component documentation]

###### G21150P

Instance id: | SA2_XTD6_VAC/GAUGE/G21150P
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

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
- 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.
- 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
- 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

###### G21160C

Instance id: | SA2_XTD6_VAC/GAUGE/G21160C
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-11
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

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
- 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.
- 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
- 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

#### HIREX

[add component documentation]

##### CAL

[add component documentation]

###### MASTER

Instance id: | SA2_XTD6_HIREX/CAL/MASTER
Class id: | SlsCalibrator
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

##### DAQ

[add component documentation]

###### GOTTHARD_MASTER

Instance id: | SA2_XTD6_HIREX/DAQ/GOTTHARD_MASTER
Class id: | GotthardReceiver
Host: | mid-rr-sys-con-11
Class documentation:
| GotthardReceiver
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### DET

[add component documentation]

###### DETECTOR_GOT

Instance id: | SA2_XTD6_HIREX/DET/DETECTOR_GOT
Class id: | GotthardControl
Host: | mid-rr-sys-con-11
Class documentation:
| GotthardControl
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

### BR

[add component documentation]

#### SYS

[add component documentation]

##### MDL

[add component documentation]

###### MID_REPEATER

Instance id: | SA2_BR_SYS/MDL/MID_REPEATER
Class id: | GenericActuator
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | MID_MAIN, UserMain, UsersBeamParameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

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
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

### SRP

[add component documentation]

#### AIBS

[add component documentation]

##### AIBS

[add component documentation]

###### MID_AIBS

## MID

### AUXT1

#### MOV

##### MOTOR

###### TY

#### UPP

##### 2

Instance id: | MID_AUXT1_UPP/2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

###### 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

##### DCTRL

###### PG1

Instance id: | MID_AUXT1_UPP/DCTRL/PG1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_AUXT1_UPP/DCTRL/PG2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_AUXT1_UPP/DCTRL/PG3
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_AUXT1_UPP/DCTRL/PG4
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_AUXT1_UPP/DCTRL/SPARE_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_AUXT1_UPP/DCTRL/SPARE_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

###### PG1

Instance id: | MID_AUXT1_UPP/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_AUXT1_UPP/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_AUXT1_UPP/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_AUXT1_UPP/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_AUXT1_UPP/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_AUXT1_UPP/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ICTRL

###### IPCTR

Instance id: | MID_AUXT1_UPP/ICTRL/IPCTR
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_AUXT1_UPP/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### IP2

Instance id: | MID_AUXT1_UPP/IPUMP/IP2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### MOTOR

###### R1

###### R2

###### R3

###### R4

###### R5

###### R6

###### T10

###### T11

###### T12

###### T13

Instance id: | MID_AUXT1_UPP/MOTOR/T13
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T14

Instance id: | MID_AUXT1_UPP/MOTOR/T14
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T15

Instance id: | MID_AUXT1_UPP/MOTOR/T15
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T16

Instance id: | MID_AUXT1_UPP/MOTOR/T16
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T2

###### T3

###### T4

###### T5

###### T6

###### T7

###### T8

###### T9

##### TSENS

###### PT1

Instance id: | MID_AUXT1_UPP/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PT2

Instance id: | MID_AUXT1_UPP/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PT3

Instance id: | MID_AUXT1_UPP/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### VALVE

###### GVD

Instance id: | MID_AUXT1_UPP/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_AUXT1_UPP/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### AVG

[add component documentation]

###### CAM1

Instance id: | MID_AUXT1_UPP/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM2

Instance id: | MID_AUXT1_UPP/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM3

Instance id: | MID_AUXT1_UPP/AVG/CAM3
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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]

###### CAM1

Instance id: | MID_AUXT1_UPP/CAM/CAM1
Class id: | LimaBaslerCamera
Host: | exflcon170
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-11-24T11:43:54.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.6.9-2.10.0
Deployment tag: | 5.6.9-2.10.0
Scenes: | MID_AUXT1_UPP/CAM/CAM1|scene, MID_SDL-CAM_mechanics, CAM_innermechanicstemp, MID_SDL-CAM_mechanics
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.6.9-2.10.0

Created: | 2020-11-24T11:03:00.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T13:03:07.000Z
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T07:21:15.000Z
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T07:18:28.000Z
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T09:00:15.000Z
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T07:10:27.000Z
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T16:47:56.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T13:52:54.000Z
Author: | Andrea Parenti
Notes: |

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

###### CAM2

Instance id: | MID_AUXT1_UPP/CAM/CAM2
Class id: | LimaBaslerCamera
Host: | exflcon135
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-11-24T11:43:54.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.6.9-2.10.0
Deployment tag: | 5.6.9-2.10.0
Scenes: | CAM_innermechanicstemp, MID_SDL-CAM_mechanics
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.6.9-2.10.0

Created: | 2020-11-24T11:03:00.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T13:03:07.000Z
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T07:21:15.000Z
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T07:18:28.000Z
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T09:00:15.000Z
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T07:10:27.000Z
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T16:47:56.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T13:52:54.000Z
Author: | Andrea Parenti
Notes: |

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

###### CAM3

Instance id: | MID_AUXT1_UPP/CAM/CAM3
Class id: | LimaBaslerCamera
Host: | exflcon170
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-11-24T11:43:54.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.6.9-2.10.0
Deployment tag: | 5.6.9-2.10.0
Scenes: | CAM_innermechanicstemp, MID_SDL-CAM_mechanics
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.6.9-2.10.0

Created: | 2020-11-24T11:03:00.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T13:03:07.000Z
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T07:21:15.000Z
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T07:18:28.000Z
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T09:00:15.000Z
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T07:10:27.000Z
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T16:47:56.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T13:52:54.000Z
Author: | Andrea Parenti
Notes: |

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

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_AUXT1_UPP/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

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.

###### CAM2

Instance id: | MID_AUXT1_UPP/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

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.

###### CAM3

Instance id: | MID_AUXT1_UPP/PROC/CAM3
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

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.

### AUXT2

#### ATT

##### MDL

###### ATT

Instance id: | MID_AUXT2_ATT/MDL/ATT
Class id: | JJAttenuator
Host: | mid-rr-sys-con-1
Class documentation:
| JJAttenuator
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/jjAttenuator
Last modified: | 2021-05-20T14:35:28.000+02:00
Created at: | 2016-12-22T15:35:45.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 2.5.3-2.11.0
Deployment tag: | 2.5.3-2.11.0
Scenes: | MID_AUXT2_ATT/MDL/ATT|buttonScene, OPT_HUTCH, MID_AUXT2_ATT-att_main, MID_MAIN, UsersBeamParameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- desiredTransmission:
    Provide a desired transmission value between 0 and 1
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an attenuator table was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current attenuator setting and target is automatically refreshed.
- posConfigRod1:
    The position configuration used by the attenuator for Rod 1. Can be only set before instantiation.
- posConfigRod2:
    The position configuration used by the attenuator for Rod 2. Can be only set before instantiation.
- posConfigRod3:
    The position configuration used by the attenuator for Rod 3. Can be only set before instantiation.
- posConfigRod4:
    The position configuration used by the attenuator for Rod 4. Can be only set before instantiation.
- positionTolerance:
    Position tolerance to identify material foils
- availableScenes:
    Scenes from the Attenuator System
- useSafeConfiguration:
    It ensures that at least one absorber on the arm of type diamond is inserted into the beam from upstream Arm(rod)
- upstreamRod:
    Select upstream rod, it can be either 1 or 4
- findTarget:
    Calculates motor positions and attenuator information for the desired transmission
- moveTarget:
    Move to target setting
- moveRod1_0:
    Rod1 0
- moveRod1_1:
    Rod1 1
- moveRod1_2:
    Rod1 2
- moveRod1_3:
    Rod1 3
- moveRod1_4:
    Rod1 4
- moveRod1_5:
    Rod1 5
- moveRod1_6:
    Rod1 6
- moveRod2_0:
    Rod2 0
- moveRod2_1:
    Rod2 1
- moveRod2_2:
    Rod2 2
- moveRod2_3:
    Rod2 3
- moveRod2_4:
    Rod2 4
- moveRod2_5:
    Rod2 5
- moveRod2_6:
    Rod2 6
- moveRod3_0:
    Rod3 0
- moveRod3_1:
    Rod3 1
- moveRod3_2:
    Rod3 2
- moveRod3_3:
    Rod3 3
- moveRod3_4:
    Rod3 4
- moveRod3_5:
    Rod3 5
- moveRod3_6:
    Rod3 6
- moveRod4_0:
    Rod4 0
- moveRod4_1:
    Rod4 1
- moveRod4_2:
    Rod4 2
- moveRod4_3:
    Rod4 3
- moveRod4_4:
    Rod4 4
- moveRod4_5:
    Rod4 5
- moveRod4_6:
    Rod4 6

Release History
2.5.3-2.11.0

Created: | 2021-05-20T12:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Use async/await syntax

2.5.2-2.10.0

Created: | 2021-02-05T13:32:28.000+01:00
Author: | Wajid Ehsan
Notes: | Protection of SI filters in ATT stacks

2.5.1-2.10.0

Created: | 2020-11-23T11:02:21.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add CI

2.5.0-2.10.0

Created: | 2020-11-19T15:38:10.000+01:00
Author: | Dennis Goeries
Notes: |

2.4.0-2.6.1

Created: | 2019-02-12T13:41:03.000+01:00
Author: | xctrl
Notes: |

2.4.0.post2-2.2.6

Created: | 2018-11-07T18:18:58.000+01:00
Author: | silenzi
Notes: | This version will be loadable from a 2.2 system

2.4.0-2.3.0

Created: | 2018-10-23T18:08:33.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.3.1-2.2.4

Created: | 2018-07-31T16:24:49.000+02:00
Author: | Dennis Goeries
Notes: |

2.3.0-2.2.4

Created: | 2018-06-13T15:51:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.2-2.2.3

Created: | 2018-05-03T14:37:48.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.1-2.2.3

Created: | 2018-04-27T11:01:33.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.0-2.2.3

Created: | 2018-04-18T17:39:22.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.2.0

Created: | 2017-12-15T17:44:24.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.14

Created: | 2017-09-11T17:37:46.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.14

Created: | 2017-09-04T18:00:19.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.14

Created: | 2017-08-18T16:30:01.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.14

Created: | 2017-08-16T17:34:40.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.12

Created: | 2017-07-21T17:30:30.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1

Created: | 2017-07-05T17:31:01.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### ROD1_IN_OUT

###### ROD2_IN_OUT

###### ROD3_IN_OUT

###### ROD4_IN_OUT

##### TSENS

###### B4C_TEMP1

Instance id: | MID_AUXT2_ATT/TSENS/B4C_TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### B4C_TEMP2

Instance id: | MID_AUXT2_ATT/TSENS/B4C_TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT_NOT_ORDERED, MID_AUXT2_ATT
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD1_TEMP1

Instance id: | MID_AUXT2_ATT/TSENS/ROD1_TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD1_TEMP2

Instance id: | MID_AUXT2_ATT/TSENS/ROD1_TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD2_TEMP1

Instance id: | MID_AUXT2_ATT/TSENS/ROD2_TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD2_TEMP2

Instance id: | MID_AUXT2_ATT/TSENS/ROD2_TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT_NOT_ORDERED, MID_AUXT2_ATT
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD3_TEMP1

Instance id: | MID_AUXT2_ATT/TSENS/ROD3_TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD3_TEMP2

Instance id: | MID_AUXT2_ATT/TSENS/ROD3_TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD4_TEMP1

Instance id: | MID_AUXT2_ATT/TSENS/ROD4_TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ROD4_TEMP2

Instance id: | MID_AUXT2_ATT/TSENS/ROD4_TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_ATT, MID_AUXT2_ATT_NOT_ORDERED
Scenes: | MID_AUXT2_ATT_TC, MID_AUXT2_ATT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### IMGPI

##### AVG

###### BEAMVIEW

Instance id: | MID_AUXT2_IMGPI/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon187
Alias: | mid-rr-sys-con-14
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: | MID_AUXT2_IMGPI/CAM/BEAMVIEW|scene, MID_AUXT2_IMGPI_AVG, MID_AUXT2_IMGPI_position
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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

###### BEAMVIEW

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

##### DCTRL

###### LED

##### MDL

###### SCREEN_POSITION

Instance id: | MID_AUXT2_IMGPI/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | mid-rr-sys-con-1
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | MID_AUXT2_IMGPI/MDL/SCREEN_POSITION|scene, MID_AUXT2_IMGPI_position, MID_AUXT2_IMGPI_MAIN, MID_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveEmpty:
    Moves the motor to the position marked with this label
- moveYAG2:
    Moves the motor to the position marked with this label
- moveYAG1:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### HOLSTER

##### PROC

###### BEAMVIEW

Instance id: | MID_AUXT2_IMGPI/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon187
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-14
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: | MID_AUXT2_IMGPI_AVG, MID_AUXT2_IMGPI_position, BeamPosition
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

##### TSYS

###### TRIGGER

Instance id: | MID_AUXT2_IMGPI/TSYS/TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MOV

##### MOTOR

###### TY

#### PSLIT

Instance id: | MID_AUXT2_PSLIT
Class id: | SlitSystem
Host: | mid-rr-sys-con-1
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/slitSystem
Last modified: | 2021-01-13T14:43:03.000+01:00
Created at: | 2016-11-16T14:10:53.000+01:00
Main authors: | Marsa, Carinan, Hickin
Latest tag: | 2.5.3-2.10.0
Deployment tag: | 2.5.3-2.10.0
Scenes: | MID_AUXT2_PSLIT|Control, MID_AUXT2_PSLIT/MOTOR/BLADE_LEFT|motorScene, MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT-SimpleControl, OPT_HUTCH, MID_AUXT2_PSLIT/MOTOR/BLADE_TOP|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_BOTTOM|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_LEFT|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_RIGHT|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_BOTTOM|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_RIGHT|motorScene, MID_AUXT2_PSLIT/MOTOR/BLADE_TOP|motorScene, MID_AUXT2_PSLIT_TC, MID_AUXT2_PSLIT|Control, MID_AUXT2_PSLIT|SimpleControl, MID_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- offsetLeft:
    Left offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetRight:
    Right offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetTop:
    Top offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetBot:
    Bot offset of motor, can only be set before instantiation or via the calibrate slot.
- reverseLeft:
    Reverse direction of Left motor axis in relation to X. Can only be set before instantiation.
- reverseRight:
    Reverse direction of Right motor axis in relation to X. Can only be set before instantiation.
- reverseTop:
    Reverse direction of Top motor axis in relation to Y. Can only be set before instantiation.
- reverseBottom:
    Reverse direction of Bot motor axis in relation to Y, can only be set before instantiation.
- positionIn:
    The defined in position. Save parameters by editing before instatiation.
- positionOut:
    The defined in position. Save parameters by editing before instatiation.
- motor:
    The motor InstanceId of the motors of the slit system.
- open:
    Open slit one step
- close:
    Close slit one step
- right:
    Move slit one step in +X
- left:
    Move slit one step in -X
- up:
    Move slit one step in Y
- down:
    Move slit one step in -Y
- closeX:
    Close slit one step in X
- openX:
    Open slit one step in X
- openY:
    Open slit one step in Y
- closeY:
    Close slit one step in Y
- calibrate:
    Set the motors offset once the slit device is CENTERED and CLOSED
- calibrateX:
    Set the motors offset in horizontal once the slit device is CENTERED and CLOSED
- calibrateY:
    Set the motors offset in vertical once the slit device is CENTERED and CLOSED
- availableScenes:
    Scenes from the Slit System

##### Release History

###### 2.5.3-2.10.0

Created: | 2021-01-13T14:43:36.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.2-2.10.0

Created: | 2020-12-23T16:44:35.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.1-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: | Summary: add CI

###### 2.5.0-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.4.0-2.2.4

Created: | 2018-06-07T09:11:44.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.5-2.2.1

Created: | 2018-04-27T11:11:40.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.4-2.2.1

Created: | 2018-03-22T14:15:20.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.3-2.2.1

Created: | 2018-03-15T10:55:54.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.2-2.2.1

Created: | 2018-03-06T13:08:58.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.1-2.2.1

Created: | 2018-02-19T18:21:55.000+01:00
Author: | Dennis Goeries
Notes: | Scene update

###### 2.3.0-2.2.1

Created: | 2018-02-19T13:27:25.000+01:00
Author: | Alessandro Silenzi
Notes: | Included SPB interface and default scenes

###### 2.2.0-2.2.0

Created: | 2017-12-12T17:37:51.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.1.9-2.1.16

Created: | 2017-10-23T13:42:52.000+02:00
Author: | David Hickin
Notes: |

###### 2.1.8-2.1.14

Created: | 2017-08-17T19:23:39.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.7-2.1.14

Created: | 2017-08-14T15:41:33.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.6-2.1.12

Created: | 2017-07-19T15:28:26.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.5

Created: | 2017-03-02T18:29:17.000+01:00
Author: | Dennis Goeries
Notes: | Migrated slitSystem

#### PSLIT

##### MOTOR

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

###### APERTURE_TA

Instance id: | MID_AUXT2_PSLIT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### APERTURE_TB

Instance id: | MID_AUXT2_PSLIT/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_BOTTOM_TA

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_BOTTOM_TA
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_BOTTOM_TB

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_BOTTOM_TB
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_LEFT_TA

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_LEFT_TA
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_LEFT_TB

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_LEFT_TB
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_RIGHT_TA

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_RIGHT_TA
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_RIGHT_TB

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_RIGHT_TB
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_TOP_TA

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_TOP_TA
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BLADE_TOP_TB

Instance id: | MID_AUXT2_PSLIT/TSENS/BLADE_TOP_TB
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_AUXT2_PSLIT
Scenes: | MID_AUXT2_PSLIT-Control, MID_AUXT2_PSLIT_TC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### VAC

##### 2

Instance id: | MID_AUXT2_VAC/2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

###### 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

##### DCTRL

###### PG1_A1

Instance id: | MID_AUXT2_VAC/DCTRL/PG1_A1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_A2

Instance id: | MID_AUXT2_VAC/DCTRL/PG1_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_B1

Instance id: | MID_AUXT2_VAC/DCTRL/PG2_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_B2

Instance id: | MID_AUXT2_VAC/DCTRL/PG2_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG3_C1

Instance id: | MID_AUXT2_VAC/DCTRL/PG3_C1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_C2

Instance id: | MID_AUXT2_VAC/DCTRL/PG4_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### GAUGE

###### PG1_A1

Instance id: | MID_AUXT2_VAC/GAUGE/PG1_A1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_A2

Instance id: | MID_AUXT2_VAC/GAUGE/PG1_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_B1

Instance id: | MID_AUXT2_VAC/GAUGE/PG2_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_B2

Instance id: | MID_AUXT2_VAC/GAUGE/PG2_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG3_C1

Instance id: | MID_AUXT2_VAC/GAUGE/PG3_C1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_C2

Instance id: | MID_AUXT2_VAC/GAUGE/PG4_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ICTRL

###### IPCTRL

Instance id: | MID_AUXT2_VAC/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_AUXT2_VAC/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### IP2

Instance id: | MID_AUXT2_VAC/IPUMP/IP2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### GVU

Instance id: | MID_AUXT2_VAC/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, MID_OPT_VAC/VS/VS_AUXT1|scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

### AUXT3

#### CAM

##### TSYS

###### TRIGGER_CAM1

Instance id: | MID_AUXT3_CAM/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_AUXT3_CAM/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

#### LIC

##### ACTRL

###### IO2

Instance id: | MID_AUXT3_LIC/ACTRL/IO2
Class id: | BeckhoffAnalogOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ASENS

###### HUM

Instance id: | MID_AUXT3_LIC/ASENS/HUM
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### IO1

Instance id: | MID_AUXT3_LIC/ASENS/IO1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TEM

Instance id: | MID_AUXT3_LIC/ASENS/TEM
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### ATT1

###### ATT2

###### MIRR1_1

###### MIRR1_2

###### MIRR2_1

###### MIRR2_2

###### TLS1

###### TLS2

##### TSENS

###### TS1

Instance id: | MID_AUXT3_LIC/TSENS/TS1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS2

Instance id: | MID_AUXT3_LIC/TSENS/TS2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TRIGGER_CAM1

Instance id: | MID_AUXT3_LIC/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_AUXT3_LIC/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### AVG

[add component documentation]

###### CAM1

Instance id: | MID_AUXT3_LIC/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon187
Alias: | mid-rr-sys-con-14
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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]

###### CAM1

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

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_AUXT3_LIC/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon187
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-14
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’, ‘midonc’]!

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.

#### MOV

##### MOTOR

###### TY

#### PAM

##### DCTRL

###### SAMPLE_CAM

Instance id: | MID_AUXT3_PAM/DCTRL/SAMPLE_CAM
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPEC_REF

Instance id: | MID_AUXT3_PAM/DCTRL/SPEC_REF
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPEC_SIG

Instance id: | MID_AUXT3_PAM/DCTRL/SPEC_SIG
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### DELAY

###### INCOUPLING1_X

###### INCOUPLING1_Y

###### INCOUPLING2_X

###### INCOUPLING2_Y

###### INCOUPLING_H_SPEC

Instance id: | MID_AUXT3_PAM/MOTOR/INCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### INCOUPLING_V_SPEC

Instance id: | MID_AUXT3_PAM/MOTOR/INCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### MIRR_D1

Instance id: | MID_AUXT3_PAM/MOTOR/MIRR_D1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### MIRR_D2

Instance id: | MID_AUXT3_PAM/MOTOR/MIRR_D2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### MIRR_U1

Instance id: | MID_AUXT3_PAM/MOTOR/MIRR_U1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### MIRR_U2

Instance id: | MID_AUXT3_PAM/MOTOR/MIRR_U2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### OUTCOUPLING_H_SPEC

Instance id: | MID_AUXT3_PAM/MOTOR/OUTCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### OUTCOUPLING_V_SPEC

Instance id: | MID_AUXT3_PAM/MOTOR/OUTCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SAMPLE1_ROT

###### SAMPLE1_X

###### SAMPLE1_Y

###### SAMPLE1_Z

###### SAMPLE2_ROT

###### SAMPLE2_X

###### SAMPLE2_Y

###### SAMPLE2_Z

###### SPECT_GRATING

##### TSYS

###### TRIGGER

Instance id: | MID_AUXT3_PAM/TSYS/TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### AVG

[add component documentation]

###### CAM1

Instance id: | MID_AUXT3_PAM/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM2

Instance id: | MID_AUXT3_PAM/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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]

###### CAM1

GENICAM CAMERAS

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

###### CAM2

GENICAM CAMERAS

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

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_AUXT3_PAM/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

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.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.

###### CAM2

Instance id: | MID_AUXT3_PAM/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

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.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.

#### VAC

##### GAUGE

###### PG1

Instance id: | MID_AUXT3_VAC/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_AUXT3_VAC/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### MIRRTY

##### TPUMP

###### TP1

Instance id: | MID_AUXT3_VAC/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### AV1

Instance id: | MID_AUXT3_VAC/VALVE/AV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV1

Instance id: | MID_AUXT3_VAC/VALVE/GV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_AUXT3_VAC/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

### BR

#### SYS

##### MDL

###### KARABACON

Instance id: | MID_BR_SYS/MDL/KARABACON
Host: | exflcon131
Class documentation:
| Karabacon
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2019-11-04T16:10:03.000+01:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Carinan, Mohacsi
Latest tag: | 1.6.1-2.6.0
Deployment tag: | 1.6.1-2.6.0
Accessible by: | CONTROLS, DA, scholzma

Warning

Installation not found in a standard path!

###### SCANTOOL_ADDON

### CR

#### SYS

##### MDL

###### OPERATION_CHANGE_NOTIFIER

Instance id: | MID_CR_SYS/MDL/OPERATION_CHANGE_NOTIFIER
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pulsePatternDecoder
Last modified: | 2019-10-04T16:10:37.000+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Mamchyk, Ehsan, Bondar
Latest tag: | 1.4.0-2.6.1
Deployment tag: | 1.3.2-2.5.0
Installed tag: | 1.4.0-2.6.1
Accessible by: | CONTROLS, DA, scholzma

Warning

The installed tag (1.4.0-2.6.1) does not match tags mentioned in the deployment ([‘1.3.2-2.5.0’])!

###### PULSE_PATTERN_DECODER

Instance id: | MID_CR_SYS/MDL/PULSE_PATTERN_DECODER
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pulsePatternDecoder
Last modified: | 2019-10-04T16:10:37.000+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Mamchyk, Ehsan, Bondar
Latest tag: | 1.4.0-2.6.1
Deployment tag: | 1.3.2-2.5.0
Installed tag: | 1.4.0-2.6.1
Accessible by: | CONTROLS, DA, scholzma

Warning

The installed tag (1.4.0-2.6.1) does not match tags mentioned in the deployment ([‘1.3.2-2.5.0’])!

###### Pulse Pattern Decoder Documentation

The `Pulse Pattern Decoder` device is documented in pulsepatterndecoder:pulsepatterndecoder

###### Pulse Pattern Decoder Troubleshooting

To troubleshooting documentation

### DAQ

#### DATA

##### DA

###### 1

Instance id: | MID_DAQ_DATA/DA/1
Class id: | DataAggregator
Host: | mid-br-sys-daq-da1
Alias: | mid-br-sys-daq-da1
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
Scenes: | agipd_overview, MID_DAQ_STATUS-OBSOLETE, agipd_overview, MID_RUN_CONTROL-OBSOLETE, agipd_overview_new, agipd_overview_old, agipd_overview0, agipd_overview, MID_RUN_CONTROL, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 2

Instance id: | MID_DAQ_DATA/DA/2
Class id: | DataAggregator
Host: | mid-br-sys-daq-da2
Alias: | mid-br-sys-daq-da2
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
Scenes: | agipd_overview, MID_DAQ_STATUS-OBSOLETE, agipd_overview, MID_RUN_CONTROL-OBSOLETE, agipd_overview_new, agipd_overview_old, agipd_overview0, agipd_overview, MID_RUN_CONTROL, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, TEMP_MONITORING
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 3

Instance id: | MID_DAQ_DATA/DA/3
Class id: | DataAggregator
Host: | mid-br-sys-daq-da1
Alias: | mid-br-sys-daq-da1
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
Scenes: | agipd_overview, MID_DAQ_STATUS-OBSOLETE, MID_RUN_CONTROL-OBSOLETE, agipd_overview_old, MID_RUN_CONTROL, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 4

Instance id: | MID_DAQ_DATA/DA/4
Class id: | DataAggregator
Host: | mid-br-sys-daq-da2
Alias: | mid-br-sys-daq-da2
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
Scenes: | agipd_overview, MID_DAQ_STATUS-OBSOLETE, MID_RUN_CONTROL-OBSOLETE, agipd_overview_old, MID_RUN_CONTROL, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 0

Instance id: | MID_DAQ_DATA/DA/0
Class id: | DataAggregator
Host: | mid-br-sys-daq-da1
Alias: | mid-br-sys-daq-da1
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
Scenes: | MID_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 20

Instance id: | MID_DAQ_DATA/DA/20
Class id: | DataAggregator
Host: | mid-br-sys-daq-da3
Alias: | mid-br-sys-daq-da3
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’, ‘midonc’]!

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: |

##### DM

###### CONFIGURATOR

Instance id: | MID_DAQ_DATA/DM/CONFIGURATOR
Class id: | RunConfigurator
Host: | mid-br-sys-daq-srv1
Alias: | mid-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_RUN_CONTROL-OBSOLETE, MID_RUN_CONTROL, MID_CUSTOMIZED_RUN_CONTROL, MID_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, MID_RUN_CONTROL_GLOBAL_STATE, MID_RUN_MONITORING_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

Instance id: | MID_DAQ_DATA/DM/DATA_MANAGER
Class id: | DataManager
Host: | mid-br-sys-daq-srv1
Alias: | mid-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’, ‘midonc’]!

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_REPORT_1

Instance id: | MID_DAQ_DATA/DM/DSG_REPORT_1
Class id: | ReportConfigGroups
Host: | mid-br-sys-daq-dsg1
Alias: | mid-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
Scenes: | EMAIL_COFIGURATION_GROUPS_OBSOLETE, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MDC_REMOTE

Instance id: | MID_DAQ_DATA/DM/MDC_REMOTE
Class id: | MetadataDBRemote
Host: | mid-br-sys-daq-srv1
Alias: | mid-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
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

###### MID_AGIPD1M_POWER_HV_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD1M_POWER_HV_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_AGIPD1M_POWER_HV_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_AGIPD1M_TEMP_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD1M_TEMP_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_AGIPD1M_TEMP_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_AGIPD1M_TSYS_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD1M_TSYS_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_AGIPD1M_TSYS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_AGIPD1M_XTDF_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD1M_XTDF_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Scenes: | MID_DAQ_DATA/DM/MID_AGIPD1M_XTDF_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_ANDOR_CAM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_ANDOR_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_AUXT2_IMGPI_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AUXT2_IMGPI_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_AUXT2_IMGPI_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_EPIX_AGIPD_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EPIX_AGIPD_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Scenes: | MID_DAQ_DATA/DM/MID_EPIX_AGIPD_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_EXP_DES_CAM2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_DES_CAM2_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_DES_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_DES_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_EPIX-1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_EPIX-1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_EPIX-2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_EPIX-2_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_EXP_SAM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_EXP_SAM_MOTOR_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_MOTOR_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_UPP_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_UPP_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_GOTTHARD_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_OPT_MONO_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_OPT_MONO_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_OPT_MONO_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_PELTIER_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_PELTIER_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_SAE_PIE725_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SAE_PIE725_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_SAE_PUMA_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SAE_PUMA_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T14:45:35.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | MID_DAQ_DATA/DM/MID_SAE_PUMA_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### MID_SCANTOOL_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SCANTOOL_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_DAQ_DATA/DM/MID_SCANTOOL_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_TESTING_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_TESTING_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_TSYS_DEVICES_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_TSYS_DEVICES_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_XTD6_IMGPI_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_XTD6_IMGPI_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### RUN_CONTROL

Instance id: | MID_DAQ_DATA/DM/RUN_CONTROL
Class id: | RunController
Host: | mid-br-sys-daq-srv1
Alias: | mid-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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, AGIPD control - Firmware tests, agipd_overview, MID_RUN_CONTROL-OBSOLETE, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, MID_RUN_CONTROL, RunStatus, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, 2548, 2718_2616, 2718_2616, Macro_EXP_PPL, 2548_xpcs, MID_CUSTOMIZED_RUN_CONTROL, MID_MAIN, MID_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, MID_RUN_CONTROL_GLOBAL_STATE, MID_RUN_MONITORING_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### SA2_BEAM_COND_1_GROUP

Instance id: | MID_DAQ_DATA/DM/SA2_BEAM_COND_1_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### SA2_BEAM_COND_2_GROUP

Instance id: | MID_DAQ_DATA/DM/SA2_BEAM_COND_2_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### SA2_BEAM_COND_3_GROUP

Instance id: | MID_DAQ_DATA/DM/SA2_BEAM_COND_3_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### checkConfigGroups

Instance id: | MID_DAQ_DATA/DM/checkConfigGroups
Class id: | CheckConfigGroups
Host: | mid-br-sys-daq-dsg1
Alias: | mid-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
Scenes: | CHECK_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS_OBSOLETE, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### MID_SAE_PUMA_DATA_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SAE_PUMA_DATA_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T14:45:35.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### MID_TIMING_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_TIMING_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_AGIPD1M_CTRL_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD1M_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_LAS_MOTOR_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_LAS_MOTOR_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_JF500K_CTRL_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_JF500K_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_EXP_JF500K_M1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_JF500K_M1_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_EXP_JF500K_M2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_JF500K_M2_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T18:06:09.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### SA2_COND_1_GROUP

Instance id: | MID_DAQ_DATA/DM/SA2_COND_1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_BAM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_BAM_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_AUXT3_PAM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AUXT3_PAM_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_UPP_LINKAM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_UPP_LINKAM_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T14:45:35.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### MID_OPT_ATT_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_OPT_ATT_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_HEXREPEATERS_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_HEXREPEATERS_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_ENERGY_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_ENERGY_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_AGIPD_MOTION_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AGIPD_MOTION_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_DES_GOTTHARD_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_DES_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_TEST_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_TEST_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

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

###### MID_AUXT3_PAM_CAM1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AUXT3_PAM_CAM1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_AUXT3_PAM_CAM2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_AUXT3_PAM_CAM2_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_DOC_ADHOC_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_DES_CAM1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_DES_CAM1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_DES_CAM3_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_DES_CAM3_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_C0_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_C0_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_C1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_C1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_C2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_C2_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_C3_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_C3_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_FASTADC_C6_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_FASTADC_C6_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_IMG_ZYLA_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_IMG_ZYLA_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_CAM1_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_CAM1_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_CAM2_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_CAM2_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_CAM3_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_CAM3_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_CAM4_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_CAM4_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_UPP_2534_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_UPP_2534_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_UPP_LAKESHORE_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_UPP_LAKESHORE_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_OPT_SDL_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_OPT_SDL_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### SA2_XTD6_HIREX_GROUP

Instance id: | MID_DAQ_DATA/DM/SA2_XTD6_HIREX_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### CONFIGURATOR_2

Instance id: | MID_DAQ_DATA/DM/CONFIGURATOR_2
Class id: | RunConfigurator
Host: | mid-br-sys-daq-srv1
Alias: | mid-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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: | MID_RUN_MONITORING_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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_2

Instance id: | MID_DAQ_DATA/DM/DATA_MANAGER_2
Class id: | DataManager
Host: | mid-br-sys-daq-srv1
Alias: | mid-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’, ‘midonc’]!

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: |

###### MDC_POLLER

###### MID_EXP_ADQ_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_ADQ_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_DOOCSBPM_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_DOOCSBPM_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_KEITHLEY_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_KEITHLEY_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_LOHEX_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_LOHEX_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_EXP_SAM_SSHEX_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_EXP_SAM_SSHEX_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_SAE_PUMA_MAGNET_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SAE_PUMA_MAGNET_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### MID_SAE_PUMA_MOTOR_GROUP

Instance id: | MID_DAQ_DATA/DM/MID_SAE_PUMA_MOTOR_GROUP
Class id: | RunConfigurationGroup
Host: | mid-br-sys-daq-dsg1
Alias: | mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+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’, ‘midonc’]!

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: |

###### RUN_CONTROL_2

Instance id: | MID_DAQ_DATA/DM/RUN_CONTROL_2
Class id: | RunController
Host: | mid-br-sys-daq-srv1
Alias: | mid-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
Scenes: | MID_RUN_MONITORING_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

##### EPIX

###### 1

Instance id: | MID_DAQ_DATA/EPIX/1
Class id: | DataAggregator
Host: | mid-br-sys-daq-da3
Alias: | mid-br-sys-daq-da3
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
Scenes: | agipd_overview, MID_RUN_CONTROL-OBSOLETE, agipd_overview_old, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 2

Instance id: | MID_DAQ_DATA/EPIX/2
Class id: | DataAggregator
Host: | mid-br-sys-daq-da3
Alias: | mid-br-sys-daq-da3
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
Scenes: | agipd_overview, MID_RUN_CONTROL-OBSOLETE, agipd_overview_old, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

##### AGIPD1MCTRL

[add component documentation]

###### 0

Instance id: | MID_DAQ_DATA/AGIPD1MCTRL/0
Class id: | DataAggregator
Host: | mid-br-sys-daq-da2
Alias: | mid-br-sys-daq-da2
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
Scenes: | MID_RUN_CONTROL-OBSOLETE, agipd_overview, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

##### JNGFR

[add component documentation]

###### 1

Instance id: | MID_DAQ_DATA/JNGFR/1
Class id: | DataAggregator
Host: | mid-br-sys-daq-da4
Alias: | mid-br-sys-daq-da4
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
Scenes: | MID_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 2

Instance id: | MID_DAQ_DATA/JNGFR/2
Class id: | DataAggregator
Host: | mid-br-sys-daq-da4
Alias: | mid-br-sys-daq-da4
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
Scenes: | MID_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

##### JNGFRCTRL

[add component documentation]

###### 0

Instance id: | MID_DAQ_DATA/JNGFRCTRL/0
Class id: | DataAggregator
Host: | mid-br-sys-daq-da4
Alias: | mid-br-sys-daq-da4
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
Scenes: | MID_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

##### MDL

[add component documentation]

###### CONNECTION_CHECK

##### DOC

[add component documentation]

###### 1

Instance id: | MID_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | mid-br-sys-daq-da4
Alias: | mid-br-sys-daq-da4
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’, ‘midonc’]!

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: |

#### DA

[add component documentation]

##### RUN_VALIDATOR

[add component documentation]

###### 1

### DET

#### AGIPD1M-1

##### CAL

###### APPEND_CORRECTED

Instance id: | MID_DET_AGIPD1M-1/CAL/APPEND_CORRECTED
Class id: | CppFemCombiner
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | CORRECTED_OVERVIEW, MANAGER, AGIPD_CORRECTED_OVERVIEW, AGIPD_PREVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | MID_DET_AGIPD1M-1/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | exflong11
Alias: | mid-br-sys-cal-9 , sa2-br-sys-daq-rcal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | MANAGER, RAW_OVERVIEW, RAW_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW_GAIN

Instance id: | MID_DET_AGIPD1M-1/CAL/APPEND_RAW_GAIN
Class id: | CppFemCombiner
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | MANAGER, RAW_OVERVIEW, RAW_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### CAL_MANAGER

Instance id: | MID_DET_AGIPD1M-1/CAL/CAL_MANAGER
Class id: | CalManager
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/karaboDevices/calPy
Last modified: | 2021-09-30T14:30:36.393+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.2.1-2.10.0-test3
Deployment tag: | 2.2.1-2.10.0-test3
Installed tag: | 2.2.0-2.10.0
Scenes: | CORRECTED_OVERVIEW, MANAGER, AGIPD_CORRECTED_OVERVIEW, MID_MAIN, AGIPD_PREVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.2.0-2.10.0) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

###### COMBINE_CORRECTED

Instance id: | MID_DET_AGIPD1M-1/CAL/COMBINE_CORRECTED
Class id: | FemDataAssembler
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | CORRECTED_OVERVIEW, MANAGER, AGIPD_CORRECTED_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINE_RAW

Instance id: | MID_DET_AGIPD1M-1/CAL/COMBINE_RAW
Class id: | FemDataAssembler
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | MANAGER, RAW_OVERVIEW, RAW_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINE_RAW_GAIN

Instance id: | MID_DET_AGIPD1M-1/CAL/COMBINE_RAW_GAIN
Class id: | FemDataAssembler
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | MANAGER, RAW_OVERVIEW, RAW_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M1
Class id: | CppFemSplitter
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M2
Class id: | CppFemSplitter
Host: | exflong11
Alias: | mid-br-sys-cal-9 , sa2-br-sys-daq-rcal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M3
Class id: | CppFemSplitter
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M4
Class id: | CppFemSplitter
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M1
Class id: | CppFemSplitter
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M2
Class id: | CppFemSplitter
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M3
Class id: | CppFemSplitter
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M4
Class id: | CppFemSplitter
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M1
Class id: | CppFemSplitter
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M2
Class id: | CppFemSplitter
Host: | exflong11
Alias: | mid-br-sys-cal-9 , sa2-br-sys-daq-rcal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M3
Class id: | CppFemSplitter
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M4
Class id: | CppFemSplitter
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M1
Class id: | CppFemSplitter
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M2
Class id: | CppFemSplitter
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M3
Class id: | CppFemSplitter
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M4
Class id: | CppFemSplitter
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.4.4-2.10.0
Scenes: | agipd_overview, CORRECTED_OVERVIEW, MANAGER, RAW_OVERVIEW, agipd_overview_old, RAW_OVERVIEW, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, AGIPD_CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### INIT

Instance id: | MID_DET_AGIPD1M-1/CAL/INIT
Class id: | InitAgipdOnlineCorrection
Host: | exflong10
Class documentation:
| InitAgipdOnlineCorrection
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/karaboDevices/calML
Last modified: | 2021-09-30T11:31:24.988+02:00
Created at: | 2018-09-04T11:04:09.000+02:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.5.0-2.10.0
Deployment tag: | 2.5.0-2.10.0
Installed tag: | 2.5.0-2.10.0
Scenes: | CORRECTED_OVERVIEW, MANAGER, AGIPD_CORRECTED_OVERVIEW, AGIPD_PREVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

- replay_delay:

    Delay in seconds between each train data

- filterRange:

    Total frames number must be power of two

- SlotVerifyConfig:

  > Verify the consistency of the configurations between the Control device and parameter conditions in Calibration Manager device.

Release History
2.5.0-2.10.0

Created: | 2021-05-17T10:27:01.000+02:00
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T13:55:22.000+02:00
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T15:47:57.000+01:00
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T13:18:42.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000+00:00
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T16:21:10.000+02:00
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T19:32:59.000+02:00
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T14:55:05.000+02:00
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T13:46:27.000+02:00
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T15:46:47.000+02:00
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T10:55:39.000+01:00
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T13:44:22.000+02:00
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T15:46:44.000+02:00
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T15:24:49.000+02:00
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T10:40:29.000+02:00
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T11:10:31.000+02:00
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T12:01:01.000+02:00
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T19:22:28.000+02:00
Author: | Steffen Hauf
Notes: |

###### MGAIN_CORR_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M1
Class id: | MGainLevelerAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M2
Class id: | MGainLevelerAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M3
Class id: | MGainLevelerAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M4
Class id: | MGainLevelerAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M1
Class id: | MGainLevelerAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M2
Class id: | MGainLevelerAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M3
Class id: | MGainLevelerAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M4
Class id: | MGainLevelerAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M1
Class id: | MGainLevelerAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M2
Class id: | MGainLevelerAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M3
Class id: | MGainLevelerAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M4
Class id: | MGainLevelerAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M1
Class id: | MGainLevelerAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M2
Class id: | MGainLevelerAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M3
Class id: | MGainLevelerAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### MGAIN_CORR_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M4
Class id: | MGainLevelerAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M1
Class id: | OffsetCorrectionAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M3
Class id: | OffsetCorrectionAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M4
Class id: | OffsetCorrectionAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M1
Class id: | OffsetCorrectionAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M3
Class id: | OffsetCorrectionAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M4
Class id: | OffsetCorrectionAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M1
Class id: | OffsetCorrectionAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M3
Class id: | OffsetCorrectionAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M4
Class id: | OffsetCorrectionAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M1
Class id: | OffsetCorrectionAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M3
Class id: | OffsetCorrectionAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### OFFSET_CORR_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M4
Class id: | OffsetCorrectionAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M1
Class id: | RelativeGainCorrection
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M2
Class id: | RelativeGainCorrection
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M3
Class id: | RelativeGainCorrection
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M4
Class id: | RelativeGainCorrection
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M1
Class id: | RelativeGainCorrection
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M2
Class id: | RelativeGainCorrection
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M3
Class id: | RelativeGainCorrection
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M4
Class id: | RelativeGainCorrection
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M1
Class id: | RelativeGainCorrection
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M2
Class id: | RelativeGainCorrection
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M3
Class id: | RelativeGainCorrection
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M4
Class id: | RelativeGainCorrection
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M1
Class id: | RelativeGainCorrection
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M2
Class id: | RelativeGainCorrection
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M3
Class id: | RelativeGainCorrection
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RELGAIN_CORR_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M4
Class id: | RelativeGainCorrection
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### RESTART

Instance id: | MID_DET_AGIPD1M-1/CAL/RESTART
Class id: | RestartCalServers
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/karaboDevices/calML
Last modified: | 2021-09-30T11:31:24.988+02:00
Created at: | 2018-09-04T11:04:09.000+02:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.5.0-2.10.0
Deployment tag: | 2.5.0-2.10.0
Installed tag: | 2.5.0-2.10.0
Scenes: | MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- 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

Release History
2.5.0-2.10.0

Created: | 2021-05-17T10:27:01.000+02:00
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T13:55:22.000+02:00
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T15:47:57.000+01:00
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T13:18:42.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000+00:00
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T16:21:10.000+02:00
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T19:32:59.000+02:00
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T14:55:05.000+02:00
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T13:46:27.000+02:00
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T15:46:47.000+02:00
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T10:55:39.000+01:00
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T13:44:22.000+02:00
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T15:46:44.000+02:00
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T15:24:49.000+02:00
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T10:40:29.000+02:00
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T11:10:31.000+02:00
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T12:01:01.000+02:00
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T19:22:28.000+02:00
Author: | Steffen Hauf
Notes: |

###### THRESHOLDING_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M1
Class id: | ThresholdingAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M2
Class id: | ThresholdingAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M3
Class id: | ThresholdingAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M4
Class id: | ThresholdingAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M1
Class id: | ThresholdingAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M2
Class id: | ThresholdingAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M3
Class id: | ThresholdingAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M4
Class id: | ThresholdingAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M1
Class id: | ThresholdingAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M2
Class id: | ThresholdingAGIPD
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M3
Class id: | ThresholdingAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M4
Class id: | ThresholdingAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M1
Class id: | ThresholdingAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M2
Class id: | ThresholdingAGIPD
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M3
Class id: | ThresholdingAGIPD
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### THRESHOLDING_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M4
Class id: | ThresholdingAGIPD
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q1M1

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M1
Class id: | MaskBadPixels
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q1M2

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M2
Class id: | MaskBadPixels
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q1M3

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M3
Class id: | MaskBadPixels
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q1M4

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M4
Class id: | MaskBadPixels
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q2M1

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M1
Class id: | MaskBadPixels
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q2M2

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M2
Class id: | MaskBadPixels
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q2M3

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M3
Class id: | MaskBadPixels
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q2M4

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M4
Class id: | MaskBadPixels
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q3M1

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M1
Class id: | MaskBadPixels
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q3M2

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M2
Class id: | MaskBadPixels
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q3M3

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M3
Class id: | MaskBadPixels
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q3M4

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M4
Class id: | MaskBadPixels
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q4M1

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M1
Class id: | MaskBadPixels
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q4M2

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M2
Class id: | MaskBadPixels
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q4M3

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M3
Class id: | MaskBadPixels
Host: | exflong16
Alias: | mid-br-sys-cal-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### BPMASK_CORR_Q4M4

Instance id: | MID_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M4
Class id: | MaskBadPixels
Host: | exflong09
Alias: | sa2-br-sys-daq-rcal-7 , mid-br-sys-cal-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

##### PROC

###### CORRECTED

Instance id: | MID_DET_AGIPD1M-1/PROC/CORRECTED
Class id: | ImageProcessor
Host: | exflcon161
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-9
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: | CORRECTED_OVERVIEW, AGIPD_CORRECTED_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

##### DET

[add component documentation]

###### 0CH0

Instance id: | MID_DET_AGIPD1M-1/DET/0CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-0
Alias: | mid-br-sys-daq-0
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 10CH0

Instance id: | MID_DET_AGIPD1M-1/DET/10CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-10
Alias: | mid-br-sys-daq-10
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 11CH0

Instance id: | MID_DET_AGIPD1M-1/DET/11CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-11
Alias: | mid-br-sys-daq-11
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 12CH0

Instance id: | MID_DET_AGIPD1M-1/DET/12CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-12
Alias: | mid-br-sys-daq-12
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 13CH0

Instance id: | MID_DET_AGIPD1M-1/DET/13CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-13
Alias: | mid-br-sys-daq-13
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 14CH0

Instance id: | MID_DET_AGIPD1M-1/DET/14CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-14
Alias: | mid-br-sys-daq-14
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 15CH0

Instance id: | MID_DET_AGIPD1M-1/DET/15CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-15
Alias: | mid-br-sys-daq-15
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 6CH0

Instance id: | MID_DET_AGIPD1M-1/DET/6CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-6
Alias: | mid-br-sys-daq-6
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 7CH0

Instance id: | MID_DET_AGIPD1M-1/DET/7CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-7
Alias: | mid-br-sys-daq-7
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 8CH0

Instance id: | MID_DET_AGIPD1M-1/DET/8CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-8
Alias: | mid-br-sys-daq-8
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

###### 9CH0

Instance id: | MID_DET_AGIPD1M-1/DET/9CH0
Class id: | DataAggregator
Host: | mid-br-sys-daq-9
Alias: | mid-br-sys-daq-9
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
Scenes: | agipd_overview, MANAGER, MID_DAQ_STATUS-OBSOLETE, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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: |

#### AGIPD1M

##### CC

###### MON_0

Instance id: | MID_DET_AGIPD1M/CC/MON_0
Class id: | Ccmon
Host: | mid-exp-sys-utc-2
Alias: | exflutc212-mch , exflqr30164-mch
Git repo: | https://git.xfel.eu/karaboDevices/ccmon
Last modified: | 2021-08-03T10:38:08.000+02:00
Created at: | 2017-03-02T15:01:59.000+01:00
Main authors: | Ehsan, Ehsanw, Silenzi
Latest tag: | 1.2.8-2.11.1
Deployment tag: | 1.2.8-2.11.1
Installed tag: | 1.2.0-2.10.0
Scenes: | agipd_overview, Clock and Control , agipd_overview, agipd_overview_new, agipd_overview_old, Clock-and-Control, Clock-and-Control, agipd_overview0, agipd_overview, Clock-and-Control-, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.2.0-2.10.0) does not match tags mentioned in the deployment ([‘1.2.8-2.11.1’])!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- pciedev:
    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5
- mapdir:
    The filesystem directory with XML files assigning logical names to internal locations in device space
- pollingInterval:
    The requested polling interval in seconds
- sdelay:
    Delay between consecutive settings
- project_version:
    Version of implemented project
- project_date:
    Date of the last change of the project.
- project_user:
    User defined register for free use within software to store and read back project related information.
- firmware_ready:
    Firmware status
- fem_status:
    FEM Status: (1) - OK (0) - not OK
- onboard_clock:
    On-board Clock: (1) - Present (0) - Absent
- tr_clock:
    Timing Receiver Clock: (1) - Present (0) - Absent
- fem_clock:
    FEM Clock: (1) - Present (0) - Absent
- timing_synch:
    When 1 - C&C synch with Timing information
- ccStandardOperation:
    Switch to standard (normal) operation.
- reset:
    Full reset.
- softReset:
    Reset clock.
- train_id:
    Current Timing Receiver Train ID (64 bits)
- train_id_mismatch:
    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID
- pll_ratio:
    Current PLL clock multiplier
- cc_slave:
    C&C board mode: Slave or Master
- cc_standalone:
    When 1 - C&C in standalone mode
- cc_trigger_mode:
    C&C Trigger mode: “Internal” or “Timing board”
- trigger_test_mode:
    Trigger simulation mode: “Continuous” or “Single”
- trigger_delay:
    Number clock cycles to delay the trigger start signal.
- trigger_period:
    Continuous trigger period
- stop_trigger_limit:
    Time between START and STOP command in 99 MHz clock cycles
- train_id_test:
    Initial train ID for standalone mode
- train_id_update:
    Writing 1 will update Train ID test
- pattern_index_test:
    Initial bunch pattern index for standalone mode.
- pattern_index_update:
    Writing 1 will update Pattern Index test
- ccTriggerStart:
    Trigger simulation start.
- ccTriggerStop:
    Trigger simulation stop.
- fast_data:
    When true - enable FAST data
- fast_custom_message:
    When 1 - send a fixed payload on the FAST line.
- fast_custom_command:
    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering

Release History
1.2.8-2.11.1

Created: | 2021-08-03T11:11:20.000+02:00
Author: | Wajid Ehsan
Notes: | Remove register WORD_VETO_SIM_RESET

1.2.7-2.11.1

Created: | 2021-07-06T16:36:46.000+02:00
Author: | Wajid Ehsan
Notes: | update utca config tag

1.2.6-2.11.1

Created: | 2021-07-05T14:13:55.000+02:00
Author: | Wajid Ehsan
Notes: | update iibus tag (Fixed bug with 32 bit signed values)

1.2.5-2.11.1

Created: | 2021-06-23T17:24:40.000+02:00
Author: | Wajid Ehsan
Notes: | Don’t poll if bunch pattern decoding is not enabled

1.2.4-2.11.1

Created: | 2021-06-15T18:08:50.000+02:00
Author: | Wajid Ehsan
Notes: | Update Depends tag

1.2.3-2.11.1

Created: | 2021-06-14T15:05:33.000+02:00
Author: | Wajid Ehsan
Notes: | Add tag for uTCAConfigurations

1.2.2-2.11.1

Created: | 2021-06-09T11:35:28.000+02:00
Author: | Wajid Ehsan
Notes: | Use tag for iibus related devices

1.2.1-2.11.1

Created: | 2021-06-02T20:23:01.000+02:00
Author: | Andrea Parenti
Notes: | Feat/v37 + init fixes + Install pciedev_io.h on CI

1.2.0-2.10.0

Created: | 2020-11-23T18:14:00.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.7.1

Created: | 2020-02-18T11:32:07.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.2.0-2.7.1-select-backplane-trigger-01

Created: | 2020-02-10T11:43:05.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.7.0

Created: | 2020-01-13T15:58:57.000+01:00
Author: | Gabriele Giovanetti
Notes: | Parameters get timestamp and trainid from local hardware.

1.0.5-2.2.4

Created: | 2018-08-03T11:10:45.000+02:00
Author: | Alessandro Silenzi
Notes: | minor fix due to name change in C&C firmware project

1.0.4-2.2.3

Created: | 2018-06-14T10:00:10.000+02:00
Author: | Andrea Parenti
Notes: | Update register names for C&C 4.1.0

1.0.3-2.2.3

Created: | 2018-06-06T11:56:51.000+02:00
Author: | Andrea Parenti
Notes: | Two fixes to expected paramers

1.0.2-2.2.1

Created: | 2018-02-22T10:59:04.000+01:00
Author: | Andrea Parenti
Notes: | Fix Netbeans configuration and Makefile for Release mode

1.0.1-2.2.1

Created: | 2018-02-09T14:08:32.000+01:00
Author: | Andrea Parenti
Notes: | Add 2.1 and 2.2 to KARABO_CLASSINFO

1.0.1-2.1.0

Created: | 2018-01-17T16:33:25.000+01:00
Author: | esenov
Notes: |

1.0.0-2.1

Created: | 2017-05-15T10:19:36.000+02:00
Author: | Andrea Parenti
Notes: | AGIPD Squad version

### EXP

#### AGIPD1M

##### ASENS

###### SPARE1

Instance id: | MID_EXP_AGIPD1M/ASENS/SPARE1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### SPARE2

Instance id: | MID_EXP_AGIPD1M/ASENS/SPARE2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

##### CHILL

###### CHILLER

Instance id: | MID_EXP_AGIPD1M/CHILL/CHILLER
Class id: | BeckhoffChiller
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, ManualCooling, agipd_overview, agipd_overview_new, agipd_overview_old, ManualCooling, agipd_overview, cooling_proc, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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:
    Start Cooling
- off:
    Stop Cooling
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- offset:
    Calibration Offset
- filterTime:
    Filter Timer for error signals

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

##### DCTRL

###### H1Q1M1_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1M1_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1M2_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1M2_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1M3_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1M4_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1M4_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1MH_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1MH_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1MH_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1MH_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1ML_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1ML_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1ML_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1ML_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q1M_AUX_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q1M_AUX_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2M1_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2M1_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2M2_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2M2_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2M3_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2M3_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2M4_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2M4_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2MH_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2MH_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2MH_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2MH_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2ML_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2ML_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2ML_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2ML_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1Q2M_AUX_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1Q2M_AUX_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1QM_MC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1QM_MC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1QM_MFPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1QM_MFPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1_MC_I

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1_MC_I
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H1_MC_RESET

Instance id: | MID_EXP_AGIPD1M/DCTRL/H1_MC_RESET
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3M1_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3M1_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3M2_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3M2_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3M3_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3M3_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3M4_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3M4_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3MH_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3MH_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3MH_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3MH_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3ML_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3ML_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3ML_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3ML_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q3M_AUX_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q3M_AUX_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4M1_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4M1_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4M2_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4M2_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4M3_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4M3_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4M4_ASIC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4M4_ASIC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4MH_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4MH_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4MH_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4MH_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4ML_ADC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4ML_ADC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4ML_FPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4ML_FPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2Q4M_AUX_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2Q4M_AUX_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2QM_MC_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2QM_MC_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2QM_MFPGA_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2QM_MFPGA_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2_MC_I

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2_MC_I
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2_MC_RESET

Instance id: | MID_EXP_AGIPD1M/DCTRL/H2_MC_RESET
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### HQM_BIAS_ILOCK

Instance id: | MID_EXP_AGIPD1M/DCTRL/HQM_BIAS_ILOCK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Global interlock (overview)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1M1POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q1M1POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1M2POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q1M2POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M1POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q2M1POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M2POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q2M2POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M1POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q3M1POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M2POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q3M2POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M1POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q4M1POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M2POWER

Instance id: | MID_EXP_AGIPD1M/DCTRL/Q4M2POWER
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MOTOR_POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1M1

Instance id: | MID_EXP_AGIPD1M/ENC/Q1M1
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1M2

Instance id: | MID_EXP_AGIPD1M/ENC/Q1M2
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M1

Instance id: | MID_EXP_AGIPD1M/ENC/Q2M1
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M2

Instance id: | MID_EXP_AGIPD1M/ENC/Q2M2
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M1

Instance id: | MID_EXP_AGIPD1M/ENC/Q3M1
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M2

Instance id: | MID_EXP_AGIPD1M/ENC/Q3M2
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M1

Instance id: | MID_EXP_AGIPD1M/ENC/Q4M1
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M2

Instance id: | MID_EXP_AGIPD1M/ENC/Q4M2
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### PG1

Instance id: | MID_EXP_AGIPD1M/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, EXP_main_Vacuum_scene, EXP_main_Vacuum_scene, AGIPD vacuum test, AGIPD control - Firmware tests, agipd_overview, DetPressure, vacuum_tests_11.04, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, ManualCooling, vacuum-test, LSHORE, agipd_overview, Temperature_and_Pressure_overview , AGIPD, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### PG2

Instance id: | MID_EXP_AGIPD1M/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, EXP_main_Vacuum_scene, EXP_main_Vacuum_scene, agipd_overview, DetPressure, agipd_overview_new, agipd_overview_old, vacuum-test, LSHORE, agipd_overview, Temperature_and_Pressure_overview , AGIPD, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### PG3

Instance id: | MID_EXP_AGIPD1M/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### PG4

Instance id: | MID_EXP_AGIPD1M/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

##### MOTOR

###### Q1M1

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q1M1
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1M2

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q1M2
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M1

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q2M1
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2M2

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q2M2
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M1

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q3M1
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3M2

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q3M2
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M1

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q4M1
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4M2

Instance id: | MID_EXP_AGIPD1M/MOTOR/Q4M2
Class id: | BeckhoffSimpleMotor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

##### PSC

###### GENGRP

Instance id: | MID_EXP_AGIPD1M/PSC/GENGRP
Class id: | MpodLVGroup
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | manual_power, power_lv_h2, power_test, power_lv_h2, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

MPOD Documentation

- Troubleshooting
- General mpod package documentation

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### H1_LV

Instance id: | MID_EXP_AGIPD1M/PSC/H1_LV
Class id: | Mpod
Host: | mid-rr-sys-con-9
Class documentation:
| Mpod
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | agipd_overview, ASIC - Power Monitoring - jola tests, AUX - Power monitoring - jola tests, power_test, ADC -Power monitoring - jola test, FPGA - Power monitoring - jola tests, MFPGA - Power Monitoring - jola test, H1 - Power Monitoring - jola tests, MC - power monitoring, power_lv_h1, agipd_overview_old, power_lv_h1, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

MPOD Documentation

- Troubleshooting
- General mpod package 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, 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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- boards:
    The node represents all MPOD boards
- channels:
    Container populated with channels discovered in the crate.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### H2_LV

Instance id: | MID_EXP_AGIPD1M/PSC/H2_LV
Class id: | Mpod
Host: | mid-rr-sys-con-9
Class documentation:
| Mpod
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | power_lv_h2, agipd_overview, power_test, power_lv_h2, MFPGA - Power Monitoring - jola test, MC - power monitoring, agipd_overview_old, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

MPOD Documentation

- Troubleshooting
- General mpod package 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, 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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- boards:
    The node represents all MPOD boards
- channels:
    Container populated with channels discovered in the crate.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### HV

Instance id: | MID_EXP_AGIPD1M/PSC/HV
Class id: | Mpod
Host: | mid-rr-sys-con-9
Class documentation:
| Mpod
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | manual_power, agipd_overview, HV - Power monitoring - jola tests, power_test, power_hv, test, manual_power, agipd_overview_old, manual_power, power_hv, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

MPOD Documentation

- Troubleshooting
- General mpod package 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, 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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- boards:
    The node represents all MPOD boards
- channels:
    Container populated with channels discovered in the crate.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### PWR_PROC_GRP

Instance id: | MID_EXP_AGIPD1M/PSC/PWR_PROC_GRP
Class id: | MpodLVGroup
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | manual_power
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

MPOD Documentation

- Troubleshooting
- General mpod package documentation

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

##### PUMP

###### SP1

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

##### SWITCH

###### H1_MC_LIVE

Instance id: | MID_EXP_AGIPD1M/SWITCH/H1_MC_LIVE
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, MC - ILC signals - test, mclive2, agipd_overview_old, MC-ILOCK-Signals, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### H1_MC_O

Instance id: | MID_EXP_AGIPD1M/SWITCH/H1_MC_O
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### H1_T_LTCC_OK

Instance id: | MID_EXP_AGIPD1M/SWITCH/H1_T_LTCC_OK
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, MC - ILC signals - test, mclive2, agipd_overview_old, MC-ILOCK-Signals, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### H2_MC_LIVE

Instance id: | MID_EXP_AGIPD1M/SWITCH/H2_MC_LIVE
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, MC - ILC signals - test, mclive2, agipd_overview_old, MC-ILOCK-Signals, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### H2_MC_O

Instance id: | MID_EXP_AGIPD1M/SWITCH/H2_MC_O
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### H2_T_LTCC_OK

Instance id: | MID_EXP_AGIPD1M/SWITCH/H2_T_LTCC_OK
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, MC - ILC signals - test, mclive2, agipd_overview_old, MC-ILOCK-Signals, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- resetCounterRegister:
    Internal

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

###### Q12COLLISION

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q12COLLISION
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1DIACOLL

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q1DIACOLL
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1LIMITDOWN

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q1LIMITDOWN
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1LIMITLEFT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q1LIMITLEFT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1LIMITRIGHT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q1LIMITRIGHT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1LIMITUP

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q1LIMITUP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q23COLLISION

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q23COLLISION
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2DIACOLL

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q2DIACOLL
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2LIMITDOWN

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q2LIMITDOWN
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2LIMITLEFT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q2LIMITLEFT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2LIMITRIGHT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q2LIMITRIGHT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2LIMITUP

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q2LIMITUP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q34COLLISION

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q34COLLISION
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3DIACOLL

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q3DIACOLL
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3LIMITDOWN

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q3LIMITDOWN
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3LIMITLEFT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q3LIMITLEFT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3LIMITRIGHT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q3LIMITRIGHT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3LIMITUP

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q3LIMITUP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q41COLLISION

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q41COLLISION
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, Q1, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4DIACOLL

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q4DIACOLL
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4LIMITDOWN

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q4LIMITDOWN
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4LIMITLEFT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q4LIMITLEFT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4LIMITRIGHT

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q4LIMITRIGHT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4LIMITUP

Instance id: | MID_EXP_AGIPD1M/SWITCH/Q4LIMITUP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | motion_tests, motion_tests_new, motion_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

##### TPUMP

###### TP1

Instance id: | MID_EXP_AGIPD1M/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, EXP_main_Vacuum_scene, EXP_main_Vacuum_scene, agipd_overview, agipd_overview_new, agipd_overview_old, agipd_overview, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

##### TSENS

###### H1_T_EXTHOUS

Instance id: | MID_EXP_AGIPD1M/TSENS/H1_T_EXTHOUS
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### H2_T_EXTHOUS

Instance id: | MID_EXP_AGIPD1M/TSENS/H2_T_EXTHOUS
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q1_T_BLOCK

Instance id: | MID_EXP_AGIPD1M/TSENS/Q1_T_BLOCK
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, test, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, agipd_overview_old, agipd_overview, test, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q2_T_BLOCK

Instance id: | MID_EXP_AGIPD1M/TSENS/Q2_T_BLOCK
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, agipd_overview_old, agipd_overview, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q3_T_BLOCK

Instance id: | MID_EXP_AGIPD1M/TSENS/Q3_T_BLOCK
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, agipd_overview_old, agipd_overview, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### Q4_T_BLOCK

Instance id: | MID_EXP_AGIPD1M/TSENS/Q4_T_BLOCK
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, AGIPD control - Firmware tests, Interlock for: MID_EXP_AGIPD1M/DCTRL/H1Q1M3_ASIC_ILOCK, agipd_overview_old, agipd_overview, DetTemp, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, Temperature_and_Pressure_overview , agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### TRIGGER

Instance id: | MID_EXP_AGIPD1M/TSYS/TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### VALVE

###### AV1

Instance id: | MID_EXP_AGIPD1M/VALVE/AV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, agipd_overview, agipd_overview_new, agipd_overview_old, agipd_overview, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

###### GVD

Instance id: | MID_EXP_AGIPD1M/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

##### DA

[add component documentation]

###### ADU

Instance id: | MID_EXP_AGIPD1M/DA/ADU
Class id: | AgipdAduHistogram
Host: | exflonc26
Alias: | sa2-br-kc-comp-2 , la2-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdAduHistogram
Last modified: | 2020-11-22T17:36:59.000+01:00
Created at: | 2019-09-16T14:38:05.000+02:00
Main authors: | Dall’antonia
Latest tag: | 1.0.1-2.9.1
Deployment tag: | 1.0.1-2.9.1
Scenes: | ADU_XY
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- userMask:
    Path to file with static mask, shape (16, 512, 128)
- buffer:
    last N elements of trend data to be stored/shown
- start:
    Start device for train processing.
- source:
    Defines data source, in case of file-data: module
- fileFormat:
    If true, module # below will be ignored
- module:
    Index to select module from all data (online only)
- pulse1:
    Index used to select POI from each train
- pulse2:
    Index used to select a compared pulse
- roi1:
    (x1, x2, y1, y2) bounding box for ROI 1
- roi2:
    (x1, x2, y1, y2) bounding box for ROI 2
- conversion:
    Conversion factor relating photons to ADU.
- intensity0:
    Used to subtract from ROI levels before ratio
- threshold:
    Used to truncate pixel ADUs to zero below peak
- avWin:
    Used for smooth trend lines
- track:
    Do Gauss-fit-based image processing to track peak
- mask:
    Restrict all-module image display to ROI1
- stop:
    Stop train processing by the device.
- counter:
    Counting received and processed trains.
- purge:
    Clear all trend-line data

Release History
1.0.1-2.9.1

Created: | 2020-10-27T13:43:35.000Z
Author: | Fabio Dall’Antonia
Notes: | Fix import error for the Karabo-internal dependency

1.0.0-2.9.1

Created: | 2020-10-27T12:25:13.000Z
Author: | Fabio Dall’Antonia
Notes: |

#### AGIPD1M1

##### CTRL

###### MC1

Instance id: | MID_EXP_AGIPD1M1/CTRL/MC1
Class id: | AgipdMC
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMC
Last modified: | 2020-11-24T11:51:15.000+01:00
Created at: | 2017-02-16T12:13:23.000+01:00
Main authors: | Parenti, Hauf, Giovanetti
Latest tag: | 1.1.3-2.10.0
Deployment tag: | 1.1.3-2.10.0
Scenes: | manual_power, agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, Module Temps - Monitoring, AGIPD control - MC , agipd_overview_old, agipd_overview, test, manual_power, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, manual_power, Temperature_and_Pressure_overview , control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- tineHome:
    The TINE_HOME to be used by the device
- address:
    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0
- pollInterval:
    The interval for polling the instrument.
- startMc:
    Start the micro-controller.
- startMasterFpga:
    Start the master FPGA.
- startAuxAndAnalogVolt:
    Start AUX and the analog voltage.
- startVacAndAnalogCards:
    Start vacuum and analog cards.
- startModuleFpga:
    Start the module FPGA.
- startAsics:
    Start the ASICS.
- startAutoPowerUp:
    Start the automatic power-up.

Release History
1.1.3-2.10.0

Created: | 2020-11-24T11:51:22.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * add version info * update test platforms

1.1.2-2.7.1

Created: | 2020-02-20T11:55:00.000+01:00
Author: | Andrea Parenti
Notes: | FIX Replace PythonDevice.fullSchema with getFullSchema()

1.1.1-2.6.4

Created: | 2019-11-25T15:33:30.000+01:00
Author: | Andrea Parenti
Notes: | Minor FIX to exception handling

1.1.0-2.6.4

Created: | 2019-11-25T14:47:05.000+01:00
Author: | Andrea Parenti
Notes: | Rename states: NORMAL->ON, ON->ACTIVE; PEP8 compliance.

1.0.7-2.4.1

Created: | 2019-05-31T17:59:39.000+02:00
Author: | Andrea Parenti
Notes: | Document how to setup TINE the first time

1.0.6-2.2.4

Created: | 2018-08-24T11:55:45.000+02:00
Author: | Andrea Parenti
Notes: | Upgrade tine dependency to use 4.6.1b1

1.0.5-2.2.3

Created: | 2018-03-01T10:09:01.000+01:00
Author: | Andrea Parenti
Notes: |

1.0.4-2.2.1

Created: | 2018-02-28T10:55:59.000+01:00
Author: | Andrea Parenti
Notes: | Fix logger spam by logging only once TINE connection timeout.

1.0.3-2.2.1

Created: | 2018-01-24T11:53:15.000+01:00
Author: | Alessandro Silenzi
Notes: | FIX: warning levels explicitly set.

1.0.2-2.1.18

Created: | 2017-10-09T09:41:09.000+02:00
Author: | Andrea Parenti
Notes: | Update TINE to version 4.6.1

1.0.1-2.1.12

Created: | 2017-08-04T14:05:55.000+02:00
Author: | Steffen Hauf
Notes: |

1.0.0-2.1

Created: | 2017-05-24T15:34:37.000+02:00
Author: | Andrea Parenti
Notes: | AGIPD Squad branch, tested at HERA-South.

###### MC2

Instance id: | MID_EXP_AGIPD1M1/CTRL/MC2
Class id: | AgipdMC
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMC
Last modified: | 2020-11-24T11:51:15.000+01:00
Created at: | 2017-02-16T12:13:23.000+01:00
Main authors: | Parenti, Hauf, Giovanetti
Latest tag: | 1.1.3-2.10.0
Deployment tag: | 1.1.3-2.10.0
Scenes: | manual_power, agipd_overview, Cooling Blocks and External Housing Temp. - jola tests at SPB, Module Temps - Monitoring, AGIPD control - MC , agipd_overview_old, agipd_overview, test, manual_power, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, manual_power, Temperature_and_Pressure_overview , control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- tineHome:
    The TINE_HOME to be used by the device
- address:
    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0
- pollInterval:
    The interval for polling the instrument.
- startMc:
    Start the micro-controller.
- startMasterFpga:
    Start the master FPGA.
- startAuxAndAnalogVolt:
    Start AUX and the analog voltage.
- startVacAndAnalogCards:
    Start vacuum and analog cards.
- startModuleFpga:
    Start the module FPGA.
- startAsics:
    Start the ASICS.
- startAutoPowerUp:
    Start the automatic power-up.

Release History
1.1.3-2.10.0

Created: | 2020-11-24T11:51:22.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * add version info * update test platforms

1.1.2-2.7.1

Created: | 2020-02-20T11:55:00.000+01:00
Author: | Andrea Parenti
Notes: | FIX Replace PythonDevice.fullSchema with getFullSchema()

1.1.1-2.6.4

Created: | 2019-11-25T15:33:30.000+01:00
Author: | Andrea Parenti
Notes: | Minor FIX to exception handling

1.1.0-2.6.4

Created: | 2019-11-25T14:47:05.000+01:00
Author: | Andrea Parenti
Notes: | Rename states: NORMAL->ON, ON->ACTIVE; PEP8 compliance.

1.0.7-2.4.1

Created: | 2019-05-31T17:59:39.000+02:00
Author: | Andrea Parenti
Notes: | Document how to setup TINE the first time

1.0.6-2.2.4

Created: | 2018-08-24T11:55:45.000+02:00
Author: | Andrea Parenti
Notes: | Upgrade tine dependency to use 4.6.1b1

1.0.5-2.2.3

Created: | 2018-03-01T10:09:01.000+01:00
Author: | Andrea Parenti
Notes: |

1.0.4-2.2.1

Created: | 2018-02-28T10:55:59.000+01:00
Author: | Andrea Parenti
Notes: | Fix logger spam by logging only once TINE connection timeout.

1.0.3-2.2.1

Created: | 2018-01-24T11:53:15.000+01:00
Author: | Alessandro Silenzi
Notes: | FIX: warning levels explicitly set.

1.0.2-2.1.18

Created: | 2017-10-09T09:41:09.000+02:00
Author: | Andrea Parenti
Notes: | Update TINE to version 4.6.1

1.0.1-2.1.12

Created: | 2017-08-04T14:05:55.000+02:00
Author: | Steffen Hauf
Notes: |

1.0.0-2.1

Created: | 2017-05-24T15:34:37.000+02:00
Author: | Andrea Parenti
Notes: | AGIPD Squad branch, tested at HERA-South.

##### FPGA

###### MASTER_H1

Instance id: | MID_EXP_AGIPD1M1/FPGA/MASTER_H1
Class id: | AgipdMaster
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.
- initAsics:
    Initialize the ASICs. The procedure will last afew seconds.
- loadPattern:
    Load pattern file to detector.
- loadBunch:
    Load bunch structure file to detector.
- configure:
    Load pattern and bunch structure files to detector.
- asicInitFile:
    Use ‘initAsics’ command to load.
- patternFile:
    Use ‘loadPattern’ or ‘configure’ command to load.
- bunchFile:
    Use ‘loadBunch’ or ‘configure’ command to load.
- triggerMode:
    The trigger mode. This parameter will be applied upon connection.
- mask:
    This parameter will be applied upon connection.
- sleepTime:
    Sleep time after pattern and bunch structure setting.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### MASTER_H2

Instance id: | MID_EXP_AGIPD1M1/FPGA/MASTER_H2
Class id: | AgipdMaster
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.
- initAsics:
    Initialize the ASICs. The procedure will last afew seconds.
- loadPattern:
    Load pattern file to detector.
- loadBunch:
    Load bunch structure file to detector.
- configure:
    Load pattern and bunch structure files to detector.
- asicInitFile:
    Use ‘initAsics’ command to load.
- patternFile:
    Use ‘loadPattern’ or ‘configure’ command to load.
- bunchFile:
    Use ‘loadBunch’ or ‘configure’ command to load.
- triggerMode:
    The trigger mode. This parameter will be applied upon connection.
- mask:
    This parameter will be applied upon connection.
- sleepTime:
    Sleep time after pattern and bunch structure setting.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q1M1

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M1
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q1M2

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M2
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q1M3

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M3
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q1M4

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M4
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q2M1

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M1
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q2M2

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M2
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q2M3

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M3
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q2M4

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M4
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, AGIPD Control - Delays, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q3M1

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M1
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q3M2

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M2
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q3M3

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M3
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q3M4

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M4
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q4M1

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M1
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q4M2

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M2
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q4M3

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M3
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### Q4M4

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M4
Class id: | AgipdReadOut
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdControlPy
Last modified: | 2020-12-07T14:56:13.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.2-2.9.8
Deployment tag: | 0.4.2-2.9.8
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- hostname:
    The FPGA hostname or IP.
- port:
    The port for TCP/IP communication with the FPGA.
- reset:
    Reset the error state (no action on the harwdare).
- bootId:
    The boot slot ID. Setting it will reboot the FPGA.

Release History
0.4.2-2.9.8

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.4.2-2.10.0

Created: | 2020-11-19T11:46:50.000+01:00
Author: | Andrea Parenti
Notes: | Same as 0.4.2-2.9.8, but ending with 2.10.0 for the sake of good order

0.4.1-2.7.1

Created: | 2020-02-19T15:02:49.000+01:00
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T10:19:15.000+01:00
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T09:35:20.000+01:00
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T08:07:20.000+01:00
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T16:52:24.000+01:00
Author: | Andrea Parenti
Notes: | First release

###### MASTER_H1_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/MASTER_H1_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### MASTER_H2_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/MASTER_H2_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-03-23T13:56:32.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti
Latest tag: | 2.1.0-2.8.0
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Scenes: | control_test, control_test_, agipd_overview, FPGAConfiguration
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.1.0-2.8.0

Created: | 2020-03-19T06:18:11.000Z
Author: | Andrea Parenti
Notes: | FIX Composite state is ACTIVE only after pressing config() FIX Use DaqController in PulseCapacitorProc and DarkImageRunCalculation FEAT In Composite, verify ‘configPath’ and create options for ‘patternBaseName’

2.0.2-2.7.1

Created: | 2020-02-20T09:47:13.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states for SETUPR in Dark and PC procedures PEP8 ADD composite unit tests

2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

###### Q1M1_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M1_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-03-23T13:56:32.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti
Latest tag: | 2.1.0-2.8.0
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Scenes: | control_test, control_test_, agipd_overview, FPGAConfiguration
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.1.0-2.8.0

Created: | 2020-03-19T06:18:11.000Z
Author: | Andrea Parenti
Notes: | FIX Composite state is ACTIVE only after pressing config() FIX Use DaqController in PulseCapacitorProc and DarkImageRunCalculation FEAT In Composite, verify ‘configPath’ and create options for ‘patternBaseName’

2.0.2-2.7.1

Created: | 2020-02-20T09:47:13.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states for SETUPR in Dark and PC procedures PEP8 ADD composite unit tests

2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

###### Q1M2_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M2_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q1M3_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M3_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q1M4_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q1M4_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q2M1_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M1_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-03-23T13:56:32.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti
Latest tag: | 2.1.0-2.8.0
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Scenes: | control_test, control_test_, agipd_overview, FPGAConfiguration
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.1.0-2.8.0

Created: | 2020-03-19T06:18:11.000Z
Author: | Andrea Parenti
Notes: | FIX Composite state is ACTIVE only after pressing config() FIX Use DaqController in PulseCapacitorProc and DarkImageRunCalculation FEAT In Composite, verify ‘configPath’ and create options for ‘patternBaseName’

2.0.2-2.7.1

Created: | 2020-02-20T09:47:13.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states for SETUPR in Dark and PC procedures PEP8 ADD composite unit tests

2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

###### Q2M2_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M2_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q2M3_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M3_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-03-23T13:56:32.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti
Latest tag: | 2.1.0-2.8.0
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Scenes: | control_test, control_test_, agipd_overview, FPGAConfiguration
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.1.0-2.8.0

Created: | 2020-03-19T06:18:11.000Z
Author: | Andrea Parenti
Notes: | FIX Composite state is ACTIVE only after pressing config() FIX Use DaqController in PulseCapacitorProc and DarkImageRunCalculation FEAT In Composite, verify ‘configPath’ and create options for ‘patternBaseName’

2.0.2-2.7.1

Created: | 2020-02-20T09:47:13.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states for SETUPR in Dark and PC procedures PEP8 ADD composite unit tests

2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

###### Q2M4_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q2M4_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q3M1_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M1_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q3M2_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M2_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q3M3_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M3_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q3M4_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q3M4_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q4M1_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M1_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q4M2_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M2_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q4M3_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M3_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

###### Q4M4_TEST

Instance id: | MID_EXP_AGIPD1M1/FPGA/Q4M4_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdControlPy
Last modified: | 2020-02-19T14:19:18.000+01:00
Created at: | 2019-05-23T08:51:49.000+02:00
Main authors: | Parenti, Giovanetti
Latest tag: | 0.4.1-2.7.1
Deployment tag: | 0.4.1-2.7.1
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

Warning

Installation not found in a standard path!

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
0.4.1-2.7.1

Created: | 2020-02-19T14:02:49.000Z
Author: | Andrea Parenti
Notes: | FIX poll_hardware only updates changed properties

0.4.0-2.7.1

Created: | 2020-02-12T09:19:15.000Z
Author: | Andrea Parenti
Notes: | Add ACQUIRING state to Read-Out FPGA

0.3.0-2.7.0

Created: | 2020-02-06T08:35:20.000Z
Author: | Andrea Parenti
Notes: | Do not spam logger with “cannot connect” messages

0.2.0-2.7.0

Created: | 2020-01-30T07:07:20.000Z
Author: | Andrea Parenti
Notes: | FIX allowed states

0.1.0-2.7.0

Created: | 2020-01-14T15:52:24.000Z
Author: | Andrea Parenti
Notes: | First release

##### MDL

###### COOLING_PROC

Instance id: | MID_EXP_AGIPD1M1/MDL/COOLING_PROC
Class id: | AgipdCoolingControlViaChiller
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_old, agipd_overview0, cooling_proc, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### DARK_PROC

Instance id: | MID_EXP_AGIPD1M1/MDL/DARK_PROC
Class id: | DarkImageRunCalculation
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | agipd_overview, agipd_overview_new, agipd_overview_old, agipd_overview, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, 2548, Macro_EXP_PPL, 2548_xpcs
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- acquisitionTime:
    Duration of dark runs.
- gain:
    The AGIPD gain settings.
- gainMode:
    The AGIPD gain mode: adaptive or fixed.
- integrationTime:
    The signal integration time per pulse (default: 12 clocks = 120 ns). It can be longer than 12 clocks for repetition rates lower than 4.5 MHz.
- nPulses:
    Number of pulses. It must be <= the number of memory cells configured in the pattern.
- sleepTimeAgipdComposite:
    Sleep time AgipdComposite to allow state change.
- stop:
    Stop Config AgipdComposite & DAQ.
- reset:
    Acknowledge errors.

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### FPGA_COMP

Instance id: | MID_EXP_AGIPD1M1/MDL/FPGA_COMP
Class id: | AgipdComposite
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | agipd_overview, MANAGER, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, control_test, agipd_overview0, agipd_overview, control_test_, agipd_overview, agipd_overview_oldold, FPGAConfiguration, agipd_overview, agipd_overview, 2548, Macro_EXP_PPL, 2548_xpcs, MID_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- tags:
    The list of tags to be enabled or disabled
- enableByTag:
    Enable devices by tag.
- disableByTag:
    Disable devices by tag.
- mcState:
    The combined state of Microcontrollers
- masterState:
    The combined state master FPGAs
- fpgaState:
    The combined state of Read-Out FPGAs
- asicInitFile:
    Use ‘initAsics’ command to load.
- acquisitionTime:
    Duration of X-Ray and Dark runs. You have to press ‘configure’ to apply.
- gain:
    The AGIPD gain settings.You have to press ‘configure’ to apply.
- gainMode:
    The AGIPD gain mode: adaptive or fixed (High, Medium or Low). Changing the gain mode will also affect the available options for the ‘Pattern Type’. You have to press ‘configure’ to apply.
- gainModeIndex:
    This property is currently needed, as the DAQ does not store strings.
- pcRowNr:
    Pulse Capacitor row number. You have to press ‘configure’ to apply.
- patternType:
    The AGIPD pattern type: XRay, Dark or PC. Changing the pattern type will also affect the available options for the ‘Gain Mode’. You have to press ‘configure’ to apply.
- patternTypeIndex:
    This property is currently needed, as the DAQ does not store strings.
- egsgat:
    For display purposes only. It will be changed by applying the configuration.
- g1sgat:
    For display purposes only. It will be changed by applying the configuration.
- g2sgat:
    For display purposes only. It will be changed by applying the configuration.
- ticolm:
    For display purposes only. It will be changed by applying the configuration.
- setupr:
    For display purposes only. It will be changed by applying the configuration.
- vrfcds:
    For display purposes only. It will be changed by applying the configuration.
- bunchStructure:
    Bunch structure settings. Use ‘configure’ command to load them.
- integrationTime:
    The signal integration time per pulse (default: 12 clocks = 120 ns). It can be longer than 12 clocks for repetition rates lower than 4.5 MHz.
- configPath:
    Path to the configuration files.
- patternBaseName:
    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt
- gainFileName:
    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.
- reset:
    Acknowledge composite errors.
- initAsics:
    Initialize the ASICs. The procedure will last a few seconds.
- configure:
    Load pattern and bunch structure files to detector.
- start:
    Start sending data.
- stop:
    Stop sending data.
- t0Delay:
    Delay of AGIPD w.r.t trigger w/o blank pulses. In units of 9.23ns ticks.

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ADC

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ADC
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ADC1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ADC1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ADC2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ADC2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ASIC

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ASIC
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ASIC1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ASIC1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_ASIC2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_ASIC2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_AUX

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_AUX
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_AUX1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_AUX1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_AUX2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_AUX2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_FPGA

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_FPGA
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_FPGA1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_FPGA1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_FPGA2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_FPGA2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_HV

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_HV
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MC

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MC
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MC1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MC1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MC2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MC2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MFPGA

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MFPGA
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, agipd_overview, AGIPD control - Firmware tests, agipd_overview_old, agipd_overview, manual_power, agipd_overview_new, agipd_overview_old, AGIPD MFPGA control for Firmware Tests0, agipd_overview0, agipd_overview, manual_power, agipd_overview, agipd_overview_oldold, agipd_overview, manual_power, agipd_overview, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MFPGA1

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MFPGA1
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Scenes: | manual_power, manual_power, manual_power, manual_power, manual_power, manual_power_GENGRP
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### INTERLOCK_OVERVIEW_MFPGA2

Instance id: | MID_EXP_AGIPD1M1/MDL/INTERLOCK_OVERVIEW_MFPGA2
Class id: | AgipdInterlockOverview
Host: | mid-rr-sys-con-9
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/agipdMiddleLayer
Last modified: | 2021-09-29T17:04:36.698+02:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Mamchykd
Latest tag: | 2.5.21-2.11.4
Deployment tag: | 2.5.21-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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

Release History
2.5.21-2.11.4

Created: | 2021-09-29T17:04:45.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix allowed states for ASICS on command [Agipd2Composite].

2.5.20-2.11.4

Created: | 2021-09-28T10:38:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: add stop functionality to composite for 2nd generation AGIPD.

2.5.19-2.11.4

Created: | 2021-09-27T09:52:09.000+02:00
Author: | Andrea Parenti
Notes: | Make # pulses settable for PC and SquareTest Shorten PC runs to 612 trains.

2.5.18-2.11.4

Created: | 2021-09-06T09:52:27.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add dummy gain mode to Agipd2Composite; * Fixes to table element for Karabo 2.11; * Protect configure slot by CHANGING state.

2.5.17-2.11.1

Created: | 2021-08-10T11:56:58.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc2-2.11.1

Created: | 2021-08-10T09:28:25.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * update config files; * FIX - wait for master FPGAs to start acquiring; * FIX - SETUPR value for fixed HG mode; * FIX - allowed states for integration time.

2.5.17rc1-2.11.1

Created: | 2021-07-30T18:57:57.000+02:00
Author: | Andrea Parenti
Notes: | FIX AgipdComposite: Wait for master FPGAs to start acquiring.

2.5.16-2.11.1

Created: | 2021-07-15T18:00:40.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update, to fit the new DAQGlobalState

2.5.15-2.11.1

Created: | 2021-06-16T08:50:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Allow saving repetition rate for Dark and PC in the project.

2.5.14-2.10.5

Created: | 2021-06-15T13:12:30.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add integration time parameter for AGIPD 1st generation.

2.5.13-2.10.4

Created: | 2021-05-20T16:01:24.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Replace all remaining ‘yield from’ with ‘await’.

2.5.12-2.10.4

Created: | 2021-05-11T09:43:47.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * fix dark procedure initial settings; * fix the way the global state is evaluated in AgipdDaqController.

2.5.11-2.10.4

Created: | 2021-04-08T16:06:36.000+02:00
Author: | Andrea Parenti
Notes: | Summary: FIX connection to interlock devices in InterlockOverview.

2.5.10-2.10.3

Created: | 2021-03-19T17:57:05.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Abort Pulse Capacitor procedure if gain mode is not ADAPTIVE.

2.5.9-2.10.2

Created: | 2021-02-25T15:21:25.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add fixed gain dark procedure.

2.5.8-2.10.1

Created: | 2021-02-22T12:37:37.000+01:00
Author: | Steffen Hauf
Notes: | Fixes to state evaluation in InterlockOverview ensuring proper time sequence of events

2.5.7-2.10.1

Created: | 2021-02-10T11:47:38.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed gain modes to PC pattern type.

2.5.6-2.10.1

Created: | 2021-02-05T11:04:10.000+01:00
Author: | Andrea Parenti
Notes: | Summary: FIX AgipdDaqController compatibility with new RunController.

2.5.5-2.10.0

Created: | 2021-02-01T11:39:37.000+01:00
Author: | Andrea Parenti
Notes: | Summary: In AgipdComposite, change dynamically options for patternType and gainMode.

2.5.4-2.10.0

Created: | 2021-01-14T13:29:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add fixed high gain mode and reorder gain modes in AgipdComposite.

###### POWER_PROC

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

###### FPGA_COMP_TEST

Instance id: | MID_EXP_AGIPD1M1/MDL/FPGA_COMP_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-02-19T15:22:19.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Giovanetti, Muennich
Latest tag: | 2.0.1-2.7.1
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Scenes: | control_test
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

1.1.4-2.2.6

Created: | 2018-12-05T14:23:38.000Z
Author: | Andrea Parenti
Notes: | Add delays between disconnect/connect of FPGA devices

1.1.3-2.2.6

Created: | 2018-11-20T13:47:07.000Z
Author: | Andrea Parenti
Notes: | Proper FIX to initial validation of cooling healt status.

###### POWER_PROC_TEST

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History

###### DARK_PROC_TEST

Instance id: | MID_EXP_AGIPD1M1/MDL/DARK_PROC_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-02-19T15:22:19.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Giovanetti, Muennich
Latest tag: | 2.0.1-2.7.1
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

1.1.4-2.2.6

Created: | 2018-12-05T14:23:38.000Z
Author: | Andrea Parenti
Notes: | Add delays between disconnect/connect of FPGA devices

1.1.3-2.2.6

Created: | 2018-11-20T13:47:07.000Z
Author: | Andrea Parenti
Notes: | Proper FIX to initial validation of cooling healt status.

###### PC_PROC_TEST

Instance id: | MID_EXP_AGIPD1M1/MDL/PC_PROC_TEST
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdMiddleLayer
Last modified: | 2020-02-19T15:22:19.000+01:00
Created at: | 2017-01-11T10:17:45.000+01:00
Main authors: | Parenti, Giovanetti, Muennich
Latest tag: | 2.0.1-2.7.1
Deployment tag: | 1.3.1-2.7.0
Installed tag: | 1.3.1-2.7.0
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

Release History
2.0.1-2.7.1

Created: | 2020-02-17T11:09:36.000Z
Author: | Andrea Parenti
Notes: | Use latest genericValidation tag

2.0.0-2.7.1

Created: | 2020-02-13T13:28:05.000Z
Author: | Andrea Parenti
Notes: | re-write AgipdComposite from scratch dapt dark and pulse capacitor procedure clean-up obsolete classes

2.0.0a1-2.7.0

Created: | 2020-01-30T14:14:49.000Z
Author: | Andrea Parenti
Notes: | First alpha for new AGIPD control.

1.3.1-2.7.0

Created: | 2019-12-20T09:55:14.000Z
Author: | Andrea Parenti
Notes: | FIX AgipdPowerControl after MC state re-definition Remove obsolete and no longer needed or supported files FIX cooling procedure test

1.3.0-2.6.4

Created: | 2019-11-05T12:40:23.000Z
Author: | Astrid Muennich
Notes: | Add pulse capacitor

1.2.8-2.6.1

Created: | 2019-09-12T06:48:46.000Z
Author: | Andrea Parenti
Notes: | Adapt to DAQ state change

1.2.7-2.5.0

Created: | 2019-08-07T08:50:06.000Z
Author: | Astrid Muennich
Notes: |

1.2.6-2.5.0

Created: | 2019-07-12T09:01:23.000Z
Author: | Astrid Muennich
Notes: | FIX cooling procedure

1.2.5-2.4.1

Created: | 2019-05-27T09:10:01.000Z
Author: | Andrea Parenti
Notes: | Remove topology check

1.2.4-2.3.1

Created: | 2019-04-10T12:54:31.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.3.1-fix-powercontrol-runcontroller-flag

Created: | 2019-04-10T12:47:00.000Z
Author: | xctrl
Notes: | Hotfix version for MID

1.2.2-2.3.1-test-fix-runcontroller-flag

Created: | 2019-04-10T12:11:18.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1-fix-runcontroller-flag

Created: | 2019-04-10T12:09:40.000Z
Author: | Astrid Muennich
Notes: |

1.2.3-2.3.1

Created: | 2019-02-11T09:16:26.000Z
Author: | Astrid Muennich
Notes: |

1.2.2-2.3.1-test

Created: | 2019-02-01T16:10:52.000Z
Author: | xctrl
Notes: |

1.2.1-2.3.1-test

Created: | 2019-02-01T15:59:58.000Z
Author: | xctrl
Notes: |

generic_validation_test20193001

Created: | 2019-01-29T10:45:48.000Z
Author: | Astrid Muennich
Notes: |

1.2.0-2.3.1

Created: | 2019-01-22T09:29:28.000Z
Author: | Steffen Hauf
Notes: |

1.1.4-2.2.6

Created: | 2018-12-05T14:23:38.000Z
Author: | Andrea Parenti
Notes: | Add delays between disconnect/connect of FPGA devices

1.1.3-2.2.6

Created: | 2018-11-20T13:47:07.000Z
Author: | Andrea Parenti
Notes: | Proper FIX to initial validation of cooling healt status.

###### DAQ_CONTROLLER

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

###### DAQ_CONTROLLER_SAVE

Instance id: | MID_EXP_AGIPD1M1/MDL/DAQ_CONTROLLER_SAVE
Class id: | DaqController
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/daqController
Last modified: | 2020-11-24T22:06:55.000+01:00
Created at: | 2019-03-11T15:44:30.000+01:00
Main authors: | Haufs, Parenti, Cas
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

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
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- autoFill:
    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.
- dataAggregators:
    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.4-2.10.0

Created: | 2020-11-24T21:11:03.000Z
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T08:53:55.000Z
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T12:48:22.000Z
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T11:27:28.000Z
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T14:30:28.000Z
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T10:43:24.000Z
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T09:20:59.000Z
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T12:03:14.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T11:52:23.000Z
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T11:19:01.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T15:29:20.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T09:22:23.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T16:38:41.000Z
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T15:45:23.000Z
Author: | Dennis Goeries
Notes: |

##### REDU

[add component documentation]

###### LITFRM

AGIPD General Documentation

- Troubleshooting
- General documentation

Related topic: Online Calibration (Online Preview)

#### ALAS

##### DCTRL

###### PG1

Instance id: | MID_EXP_ALAS/DCTRL/PG1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG1_HIGH

Instance id: | MID_EXP_ALAS/DCTRL/PG1_HIGH
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG1_LOW

Instance id: | MID_EXP_ALAS/DCTRL/PG1_LOW
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_ALAS/DCTRL/PG2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PW1

Instance id: | MID_EXP_ALAS/DCTRL/PW1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_ALAS-overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_ALAS/DCTRL/SPARE_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B1

Instance id: | MID_EXP_ALAS/DCTRL/SPARE_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_ALAS/DCTRL/SPARE_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_C2

Instance id: | MID_EXP_ALAS/DCTRL/SPARE_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

###### PG1

Instance id: | MID_EXP_ALAS/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_ALAS/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_ALAS/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B1

Instance id: | MID_EXP_ALAS/GAUGE/SPARE_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_ALAS/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_C2

Instance id: | MID_EXP_ALAS/GAUGE/SPARE_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ICTRL

###### IPCTRL

Instance id: | MID_EXP_ALAS/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_EXP_ALAS/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### ALAS

Instance id: | MID_EXP_ALAS/MDL/ALAS
Class id: | MidAlignmentLaser
Host: | exflcon61n0
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/midAlignmentLaser
Last modified: | 2020-11-26T17:53:06.000+01:00
Created at: | 2018-12-19T10:29:15.000+01:00
Main authors: | Fabbri, Haufs, Schaffer
Latest tag: | 1.0.1-2.10.0
Deployment tag: | 1.0.1-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- powerProxy:
    Karabo name of the power controls for this laser
- off:
    Turns the laser off
- on:
    Turns the laser on
- mirrTy:
    Controls for the TY motor in the vacuum
- mirr1T1:
    Horizontal tilt of the 1st optical mirror
- mirr1T2:
    Vertical tilt of the 1st optical mirror
- mirr2T1:
    Horizontal tilt of the 2nd optical mirror
- mirr2T2:
    Vertical tilt of the 2nd optical mirror
- lasy:
    Controls for the LASY motor, changing the height of thebeam
- fw1:
    Controls for the filter wheel in the alignment laser
- imagerLocation:
    Location of imager which detects the laser, ifapplicable
- stopAll:
    Orders all motors to stop

Release History
1.0.1-2.10.0

Created: | 2020-11-26T17:06:19.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.0-2.3.2

Created: | 2019-02-15T09:16:34.000Z
Author: | Robert Schaffer
Notes: | First implementation of device

##### MOTOR

###### FW1

###### LASY

###### MIRR1_T1

###### MIRR1_T2

###### MIRR2_T1

###### MIRR2_T2

###### MIRRTY

##### SWITCH

###### PG1_HIGH

Instance id: | MID_EXP_ALAS/SWITCH/PG1_HIGH
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_LOW

Instance id: | MID_EXP_ALAS/SWITCH/PG1_LOW
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### VALVE

###### GVD

Instance id: | MID_EXP_ALAS/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_EXP_ALAS/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

#### BIAS

##### DCTRL

###### ILOCK_01

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_02

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_03

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_03
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_04

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_04
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_05

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_05
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_06

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_06
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_07

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_07
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### ILOCK_08

Instance id: | MID_EXP_BIAS/DCTRL/ILOCK_08
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | INTERLOCK_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### MPOD_BIAS

Instance id: | MID_EXP_BIAS/DCTRL/MPOD_BIAS
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MCPS

###### DETLVHV

Instance id: | MID_EXP_BIAS/MCPS/DETLVHV
Class id: | Mpod
Host: | mid-rr-sys-con-10
Class documentation:
| Mpod
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | EPIX-1-IV-plots, EPIX-2-SUBSYS, SOLN_1_U0, MID_EXP_DES/CON/MDL_CONTROL|power_scene, SOLN_1, PeltierCooler, TEST, PeltierCooler20200, MID_POWER_EPIX2, Diamond_45MHz, MID_POWER_EPIX1, SOLN_1_real, MID_HVTEST_CHAN14, MID_HVTEST_CHAN13, MID_HVTEST_CHAN12, Diamond_Detector, MID_EXP_DES/CON/MDL_CONTROL|power_scene, MID_HVTEST_CHAN15, MPOD_RESETING, EPIX-1-SUBSYS, EPIX1_IV_plots, EPIX2_IV_plots, JF01-subsys, JF-subsys, JF01-subsys0, JF-subsys-new, JF-subsys, EPIX-ALL, Diamond_Duolateral, EPIX1, MID_EXP_SAM/LODD, MID_EXP_SAM/MPCDD, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package 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, 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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- boards:
    The node represents all MPOD boards
- channels:
    Container populated with channels discovered in the crate.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### DETAUX

Instance id: | MID_EXP_BIAS/MCPS/DETAUX
Class id: | Mpod
Host: | mid-rr-sys-con-10
Class documentation:
| Mpod
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package 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, 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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- crateNode:
    Container for crate properties
- boards:
    The node represents all MPOD boards
- channels:
    The node represents all MPOD channels

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

##### MDL

[add component documentation]

###### EPIXES_POWER

###### EPIXES_TAGGROUP

Instance id: | MID_EXP_BIAS/MDL/EPIXES_TAGGROUP
Class id: | TagGroup
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/mpod
Last modified: | 2020-11-24T12:17:30.000+01:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.2-2.10.0
Deployment tag: | 5.2.2-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices

Release History
5.2.2-2.10.0

Created: | 2020-11-24T07:19:01.000Z
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T15:53:16.000Z
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T14:56:55.000Z
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T06:47:34.000Z
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T08:58:57.000Z
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T10:03:13.000Z
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T11:50:05.000Z
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T09:54:22.000Z
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T21:19:39.000Z
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T06:14:37.000Z
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T08:58:18.000Z
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T08:43:24.000Z
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T06:45:03.000Z
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T11:58:01.000Z
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T14:25:51.000Z
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T09:48:53.000Z
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T08:22:50.000Z
Author: | Wajid Ehsan
Notes: |

4.0.1-2.1.15

Created: | 2017-09-04T10:17:24.000Z
Author: | Chen Xu
Notes: | fixed setup.py

#### CHILL1

##### ASENS

###### FM1_1

Instance id: | MID_EXP_CHILL1/ASENS/FM1_1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_CHILL1/ASENS/FM1_1|scene, EPIX-2-SUBSYS, MID_EXP_CHILL1/ASENS/FM1_1|scene, CHILL1, EPIX-1-SUBSYS, JF01-subsys, JF-subsys, JF01-subsys0, JF-subsys-new, JF-subsys, EPIX-ALL, EPIX1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM1_2

Instance id: | MID_EXP_CHILL1/ASENS/FM1_2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EPIX-ALL, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM2_1

Instance id: | MID_EXP_CHILL1/ASENS/FM2_1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM2_2

Instance id: | MID_EXP_CHILL1/ASENS/FM2_2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM1_1

Instance id: | MID_EXP_CHILL1/ASENS/PM1_1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_CHILL1/ASENS/PM1_1|scene, EPIX-2-SUBSYS, MID_EXP_CHILL1/ASENS/PM1_1|scene, CHILL1, EPIX-1-SUBSYS, JF01-subsys, JF-subsys, JF01-subsys0, JF-subsys-new, JF-subsys, EPIX-ALL, EPIX1, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM1_2

Instance id: | MID_EXP_CHILL1/ASENS/PM1_2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EPIX-ALL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### CHILL

###### CTRL

Instance id: | MID_EXP_CHILL1/CHILL/CTRL
Class id: | BeckhoffChiller
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EPIX-2-SUBSYS, CHILL1, EPIX-1-SUBSYS, JF01-subsys, JF-subsys, JF01-subsys0, JF-subsys-new, JF-subsys, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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:
    Start Cooling
- off:
    Stop Cooling
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- offset:
    Calibration Offset
- filterTime:
    Filter Timer for error signals

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

#### CHILL2

##### ASENS

###### FM1

Instance id: | MID_EXP_CHILL2/ASENS/FM1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM2

Instance id: | MID_EXP_CHILL2/ASENS/FM2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM3

Instance id: | MID_EXP_CHILL2/ASENS/FM3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### FM4

Instance id: | MID_EXP_CHILL2/ASENS/FM4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM1

Instance id: | MID_EXP_CHILL2/ASENS/PM1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM2

Instance id: | MID_EXP_CHILL2/ASENS/PM2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM3

Instance id: | MID_EXP_CHILL2/ASENS/PM3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PM4

Instance id: | MID_EXP_CHILL2/ASENS/PM4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### CHILL

###### CTRL

Instance id: | MID_EXP_CHILL2/CHILL/CTRL
Class id: | BeckhoffChiller
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | agipd_overview, agipd_overview_old, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview, EPIX-ALL, EPIX1, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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:
    Start Cooling
- off:
    Stop Cooling
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- offset:
    Calibration Offset
- filterTime:
    Filter Timer for error signals

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

#### DES

##### AVG

###### CAM1

Instance id: | MID_EXP_DES/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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: | Cam1, Imager_Main_DES, MID_EXP_DES/CAM/CAM1|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM2

Instance id: | MID_EXP_DES/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM3

Instance id: | MID_EXP_DES/AVG/CAM3
Class id: | ImageAverager
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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: | cam3big_avg0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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

###### CAM1

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

###### CAM2

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

###### CAM3

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

###### CAM2_BAK

Instance id: | MID_EXP_DES/CAM/CAM2_BAK
Class id: | LimaBaslerCamera
Host: | mid-rr-sys-con-14
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### CON

###### MDL_CONTROL

Instance id: | MID_EXP_DES/CON/MDL_CONTROL
Class id: | DiagnosticEndStation
Host: | mid-rr-sys-con-2
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/diagnosticEndStation
Last modified: | 2020-12-01T17:24:20.000+01:00
Created at: | 2018-11-06T18:08:14.000+01:00
Main authors: | Fabbri, Haufs, Schaffer
Latest tag: | 1.1.2-2.10.0
Deployment tag: | 1.1.2-2.10.0
Scenes: | MID_EXP_DES/CON/MDL_CONTROL|power_scene, quick_power_scene, DES_Diamond_Detector
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- motorTy:
    Controls for the TY motor of the table
- filterWheel:
    Controls for the filter wheel
- imager:
    Controls for the Imager
- detectorSignals:
    Controls the intensity monitors
- spectMotors:
    Motors controlling the general movement of theSpectrometer
- stopAll:
    Orders all motors to stop

Release History
1.1.2-2.10.0

Created: | 2020-11-26T15:48:12.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.1.1-2.7.0

Created: | 2020-03-09T16:11:35.000+01:00
Author: | xctrl
Notes: | Tag with online fixes to integrator

1.1.0-2.5.0

Created: | 2019-05-24T18:03:24.000+02:00
Author: | Robert Schaffer
Notes: | Bugfix tag, consistent with changes done locally

1.0.1-2.3.2

Created: | 2019-02-15T13:47:12.000+01:00
Author: | Robert Schaffer
Notes: | Fixed issue with module tracking

1.0.0-2.3.2

Created: | 2019-02-15T10:23:32.000+01:00
Author: | Robert Schaffer
Notes: | First implementation of device

###### MDL_TEST

Instance id: | MID_EXP_DES/CON/MDL_TEST
Class id: | DiagnosticEndStation
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/diagnosticEndStation
Last modified: | 2020-11-26T15:41:42.000+01:00
Created at: | 2018-11-06T18:08:14.000+01:00
Main authors: | Fabbri, Haufs, Schaffer
Latest tag: | 1.1.2-2.10.0
Deployment tag: | 1.1.2-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- motorTy:
    Controls for the TY motor of the table
- filterWheel:
    Controls for the filter wheel
- imager:
    Controls for the Imager
- detectorSignals:
    Controls the intensity monitors
- spectMotors:
    Motors controlling the general movement of theSpectrometer
- stopAll:
    Orders all motors to stop

Release History
1.1.2-2.10.0

Created: | 2020-11-26T14:48:12.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.1.1-2.7.0

Created: | 2020-03-09T15:11:35.000Z
Author: | xctrl
Notes: | Tag with online fixes to integrator

1.1.0-2.5.0

Created: | 2019-05-24T16:03:24.000Z
Author: | Robert Schaffer
Notes: | Bugfix tag, consistent with changes done locally

1.0.1-2.3.2

Created: | 2019-02-15T12:47:12.000Z
Author: | Robert Schaffer
Notes: | Fixed issue with module tracking

1.0.0-2.3.2

Created: | 2019-02-15T09:23:32.000Z
Author: | Robert Schaffer
Notes: | First implementation of device

##### DCTRL

###### CAM1

Instance id: | MID_EXP_DES/DCTRL/CAM1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### CAM2

Instance id: | MID_EXP_DES/DCTRL/CAM2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### CAM3

Instance id: | MID_EXP_DES/DCTRL/CAM3
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### DET

###### GOTTHARD_CALIBRATION

Instance id: | MID_EXP_DES/DET/GOTTHARD_CALIBRATION
Class id: | SlsCalibrator
Host: | mid-rr-sys-con-8
Alias: | mid-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | test, DES_GOTTHARD, DES_GOTTHARD_NEW0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

###### GOTTHARD_CONTROL

Instance id: | MID_EXP_DES/DET/GOTTHARD_CONTROL
Class id: | GotthardControl
Host: | mid-rr-sys-con-8
Class documentation:
| GotthardControl
Alias: | mid-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | DES_GOTTHARD, MID_MAIN, ScanMacro, ScanMacro, DES_GOTTHARD_NEW0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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 acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### GOTTHARD_RECEIVER

Instance id: | MID_EXP_DES/DET/GOTTHARD_RECEIVER
Class id: | GotthardReceiver
Host: | mid-rr-sys-con-8
Class documentation:
| GotthardReceiver
Alias: | mid-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | DES_GOTTHARD, TMP, MID_RR_SYS/ZMQ/GOTTHARD|scene, DES_GOTTHARD_NEW0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### GAUGE

###### PG1

Instance id: | MID_EXP_DES/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene, AGIPD
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_DES/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_DES/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_DES/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### BEND1

Instance id: | MID_EXP_DES/MOTOR/BEND1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Spect Motors, Spectrometer Motors, All DES motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### BEND2

Instance id: | MID_EXP_DES/MOTOR/BEND2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Spect Motors, Spectrometer Motors, All DES motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### DET1_TX

Instance id: | MID_EXP_DES/MOTOR/DET1_TX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_DES/CON/MDL_CONTROL|power_scene, original-power-scene, Diamond_Detector, All DES motors, DES_Diamond_Detector, DES_Motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### DET2_TX

Instance id: | MID_EXP_DES/MOTOR/DET2_TX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | All DES motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### DET_TY

###### FOCUS

###### FW1

Instance id: | MID_EXP_DES/MOTOR/FW1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Imager, All DES motors, DES_Motors, DES_Imager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### RC1

Instance id: | MID_EXP_DES/MOTOR/RC1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | All DES motors, DES_Motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### RC2

Instance id: | MID_EXP_DES/MOTOR/RC2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | All DES motors, DES_Motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SCREEN_TX

Instance id: | MID_EXP_DES/MOTOR/SCREEN_TX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_DES/MOTOR/SCREEN_TX|motorScene, Imager, Imager Controls, All DES motors, DES_Motors, DES_Imager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SCREEN_TY

Instance id: | MID_EXP_DES/MOTOR/SCREEN_TY
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Imager, Imager Controls, All DES motors, DES_Motors, DES_Imager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SCREEN_TZ

Instance id: | MID_EXP_DES/MOTOR/SCREEN_TZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Imager, Imager Controls, All DES motors, DES_Motors, DES_Imager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SPARE1

Instance id: | MID_EXP_DES/MOTOR/SPARE1
Class id: | BeckhoffMC2Base
Host: | exflcon61n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- 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 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
- home:
    CHoming
- on:
    CEnableAxis
- off:
    CDisableAxis
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    CResetAxis
- specificError:
    ASpecificError
- moveRelative:
    CMoveRelative
- move:
    CMoveAbsolute
- emergencyStop:
    CStop
- stop:
    CHalt
- moveConstantVelocity:
    set property amovevelocity
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

Release History
4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPARE2

Instance id: | MID_EXP_DES/MOTOR/SPARE2
Class id: | BeckhoffMC2Base
Host: | exflcon61n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- 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 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
- home:
    CHoming
- on:
    CEnableAxis
- off:
    CDisableAxis
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    CResetAxis
- specificError:
    ASpecificError
- moveRelative:
    CMoveRelative
- move:
    CMoveAbsolute
- emergencyStop:
    CStop
- stop:
    CHalt
- moveConstantVelocity:
    set property amovevelocity
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

Release History
4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPEC_TX

###### XTAL_RX

Instance id: | MID_EXP_DES/MOTOR/XTAL_RX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | Spect Motors, Spectrometer Motors, All DES motors, DES_Motors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### XTAL_RZ

###### XTAL_TX

###### XTAL_TY

###### ZOOM

##### PROC

###### CAM1

Instance id: | MID_EXP_DES/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
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: | Cam1, BeamPosition, Imager_Main_DES
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### CAM2

Instance id: | MID_EXP_DES/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
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: | BeamPosition, testcam2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### CAM3

Instance id: | MID_EXP_DES/PROC/CAM3
Class id: | ImageProcessor
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
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: | BeamPosition
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.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.

###### ADC_PROC_TEST

Instance id: | MID_EXP_DES/PROC/ADC_PROC_TEST
Class id: | ImageProcessor
Host: | exflcon147
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-7
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’, ‘midonc’]!

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.

###### GOTTHARD

Instance id: | MID_EXP_DES/PROC/GOTTHARD
Class id: | ImageProcessor
Host: | exflcon143
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-8
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’, ‘midonc’]!

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.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.

##### PUMP

###### SP1

##### SWITCH

###### FLOW

Instance id: | MID_EXP_DES/SWITCH/FLOW
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

##### TSENS

###### TEMP1

Instance id: | MID_EXP_DES/TSENS/TEMP1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | build, MID_EXP_DES/TSENS/TEMP1|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TEMP2

Instance id: | MID_EXP_DES/TSENS/TEMP2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | build
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TEMP3

Instance id: | MID_EXP_DES/TSENS/TEMP3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | build
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TRIGGER_CAM1

Instance id: | MID_EXP_DES/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_EXP_DES/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM3

Instance id: | MID_EXP_DES/TSYS/TRIGGER_CAM3
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### GOTTHARD_GATE

Instance id: | MID_EXP_DES/TSYS/GOTTHARD_GATE
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### VALVE

###### AV1

Instance id: | MID_EXP_DES/VALVE/AV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVD

Instance id: | MID_EXP_DES/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_EXP_DES/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TPUMP

###### TP1

Instance id: | MID_EXP_DES/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

##### MDL

[add component documentation]

###### CHANNEL_0_INT

###### CHANNEL_1_INT

###### CHANNEL_2_INT

###### CHANNEL_3_INT

###### CHANNEL_4_INT

###### CHANNEL_5_INT

###### CHANNEL_6_INT

###### CHANNEL_7_INT

###### CHANNEL_8_INT

###### CHANNEL_9_INT

###### GOTTHARD_INTERFACE

#### DPS

##### DCTRL

###### CR1_VALVE

Instance id: | MID_EXP_DPS/DCTRL/CR1_VALVE
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

###### PG1

Instance id: | MID_EXP_DPS/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_DPS/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_DPS/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_DPS/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG5

Instance id: | MID_EXP_DPS/GAUGE/PG5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG6

Instance id: | MID_EXP_DPS/GAUGE/PG6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### RY

###### TX

###### TX1

###### TX2

###### TY

###### TY1

###### TY2

##### SWITCH

###### CR1_SWITCHA

Instance id: | MID_EXP_DPS/SWITCH/CR1_SWITCHA
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CR1_SWITCHB

Instance id: | MID_EXP_DPS/SWITCH/CR1_SWITCHB
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### RY

Instance id: | MID_EXP_DPS/SWITCH/RY
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TX

Instance id: | MID_EXP_DPS/SWITCH/TX
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TY

Instance id: | MID_EXP_DPS/SWITCH/TY
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### AV1

Instance id: | MID_EXP_DPS/VALVE/AV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### AV2

Instance id: | MID_EXP_DPS/VALVE/AV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### AV3

Instance id: | MID_EXP_DPS/VALVE/AV3
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV1

Instance id: | MID_EXP_DPS/VALVE/GV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV2

Instance id: | MID_EXP_DPS/VALVE/GV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV3

Instance id: | MID_EXP_DPS/VALVE/GV3
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_EXP_DPS/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TPUMP

###### TP1

Instance id: | MID_EXP_DPS/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP2

Instance id: | MID_EXP_DPS/TPUMP/TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP3

Instance id: | MID_EXP_DPS/TPUMP/TP3
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Projects: | MID_EXP_DPS
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

#### EPIX-1

#### ePix System Overview

##### System description

The ePIX100 1M detector (EPIX) is implemented by operating two 0.5Mpxl ePIX detectors (in parallel) as a combined unit. To avoid confusion the term module will be used in the remainder of this document when describing a 0.5Mpxl detector. The 1Mpsx EPIX detector to be implemented consists of two identical 0.5Mpxl modules: M1 and M2.

The Epix100A camera is a pixel sensor camera supplied by SLAC. The camera module consists of a sensor (front) plane and electronics to acquire and control the module. Sensors and electronics are mechanically connected together in a single box format, as shown below. This means that if the sensors are to be operated in-vacuum, then the entire module box must be in-vacuum.

Related sub-systems required to operate the camera are chiller, power, sequencing and trigger control, and readout as shown schematically below..

This documentation assumes that modules are operated in-vacuum and includes a description of the flange feedthrough.

Technical details referred to in this overview are extracted from the “ePix100A camera Handling, the Installation Guide” and “Calibration, Operations and Software Development Guide” both of which are available in preliminary form. Additional requirements are taken from a summary table defined with the manufacturer.

This detector requires external low voltage (LV) and high voltage (HV) supplies and an external control of the Peltier element (TEC). It also requires a PLC interlock to drive the detector into a safe state, see the interlock section below.

The remainder of the description has been split into the following sections:

- Connections per module
- Trigger
- Operation restrictions
- The power operator
- Cooling
- Interlock

##### Connections per module

All connections required to control, readout and cool a module are mounted on the back plate, see below.

Details of connections required for a single module:

- 1 x DB26 per module connector for power, sequencing, trigger and timing, and control IO

Pin assignment | Function | Notes
--- | --- | ---
1 | Unused TTL output | Leave open
2 | Digital ground |
3 | Unused TTL output | Leave open
4 | Digital ground |
5 | DAQ trigger input | 5.5V TTL, Polarity +, min pulse width 100ns.
6 | Digital bias ground |
7 | RUN trigger input | 5.5V TTL, Polarity +, min pulse width 100ns.
8 | Digital ground |
9 | Detector bias | 10V-200V DC 250uA, recommend 200VDC 250uA
10 | Analog ground | Tied to camera common analog ground
11 | Digital ground |
12 | Analog ground |
13 | Digital ground |
14 | Spare thermistor ground |
15 | Analog ground |
16 | Digital ground |
17 | TEC ground |
18 | Detector ground |
19 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
20 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
21 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
22 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
23 | Spare thermistor |
24 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
25 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
26 | TEC power | see special specs.

- 1 x SFP+ IP 10Gbit MMF for use with the DAQ readout network
- 2 x Swagelok quick connectors for cooling water circuit (1 off picture).

To simplify connecting many cables each with different, often large, connectors (LV and associated sense lines, BIAS, Peltier, etc.) to the DB26 plug of EPIX modules, connection boxes were implemented for single module, M1, and dual, M1 and M2, installations.

Additional details of fibers required for use with the DAQ network at EuXFEL are shown in the following table.

DAQ connection | Spec | Comment
--- | --- | ---
fibre cable | OM4 | 50x125mu gradient index, multi-mode-3.3
connector | LC-LC |
SFP+ module | 10G | provided by manufacturer (AFBR-57D9AMZ) Avago, 850nm

Image data readout is transferred from the camera to a remote PC with PGP protocol over a fibre and requires the PCIe card, shown below, to be installed in the PC plus s/w drivers provided by the manufacturer. Two SFP+ are required for a 1Mpxl detector, one for M1 and another for M2, leaving two unused ports on the PCIe board.

##### Trigger

Two trigger signals are specified by the provider and both have electrical characteristics shown in the table below. Signal IO is via the DB26 connector. The trigger signals specified: a RUN (pin 7) image capture in the front-end electronics and DAQ (pin 5) package and dispatch image data to the remote PC can be delivered to a module by the EuXFEL ETA (External Trigger Adapter) box - a single ETA box can drive up to 3 IO signals, thus two ETA boards are required to provide the 4 trigger lines for the two module 1Mpxl detector.

The train number and pulse numbers of data acquired are inserted into the dataflow by ITDM using a mechanism similar to that for other commercial cameras.

Trigger | Electrical characteristic | Comment
--- | --- | ---
signal | 5.5V TTL | triggers on positive slope?
Input impedance | 50 Ohm |
polarity | plus |
Slope | positive |
min pulse width | 100ns |
connector | DB26 |
trigger to event delay | 100us |

##### Operation restrictions

It is useful to know when damage can occur and the provider has defined the following restrictions

Operation condition | Max time w/o damage to modules
--- | ---
in-air, no cooling, no beam, 10Hz clocking | ?
in-vacuum, no cooling, no beam, 10Hz clocking | ?

##### Power

Module power requirements are summarized in the table below. Throughout the document LV is used when referring to voltage supplied to power module electronics (digital and analog) and HV or BIAS is used when referring to sensor bias voltage.

All voltages are supplied through the DB26 connector. The 1Mpxl detector requires 2 modules and therefore 2 sets of power lines. The suggested power supplies for the low voltage, both analogue and digital, is the Wiener 8016. The suggested power supply for the high voltage supply is Iseg EHS8405p_SHV. Both detector modules can be powered from a single power-supply module, (HV and LV respectively) which is beneficial for the implementation of the interlock.

Power | Value | Comment
--- | --- | ---
LV ANALOG (DC) | (+)6.0V | positive voltage, static
operation range | 4.5-6.6V |
Vpp ripple | <3mV |
Vrms ripple | <1.0mV |
line regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
load regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
Umax | 6.6V | threshhold when damage is expected
Imax | 4.0 A | power supply max value
connector type on module | DB26 +ve (pins 19, 21, 24) return (10, 12, 15) |
LV DIGITAL (DC) | (+)6.0V | positive voltage, static
operation range | 4.5-6.6V |
Vpp ripple | <3mV |
Vrms ripple | <1.0mV |
line regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
load regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
Umax | 6.6V | threshhold when damage is expected
Imax | 2A | power supply max value
connector type on module | DB26 +ve (pins 20, 22, 25) return (11, 13, 16) |
HV BIAS (DC) | (+)200V | positive voltage, static
operation range | 100-220V | working range of power supply
Vpp ripple | <5mV |
Vrms ripple | <2mV | PSI operates at <1.5mV rms
line regulation | <0.01% |
load regulation | <0.01% + 100µV | +/- (% of output +offset)
Umin, Umax | 10V, 250V | threshhold when damage is expected, Biasing below 10V will eventually damage the ASIC
Imax | 250uA |
V up/down ramping | not needed | Is ramping of the sensor bias needed? If yes please specify speed [V/s]
connector type on module | DB26 +ve (pin 9) return (pin 6) |

Each module requires 2 x LV and 1 x HV channel and these will be supplied by the small detector and diode power system described in MID_EXP_BIAS which is capable of delivering the voltages defined and integrating these with a PLC driven interlock.

The CONTROL name of a voltage channel (2-wire) is ComponentName + “/PSC/” + ChannelName, thus for the two modules described in this note the CONTROL names are:

- MID_EXP_EPIX/PSC/M1_LV_ANALOG
- MID_EXP_EPIX/PSC/M1_LV_DIGITAL
- MID_EXP_EPIX/PSC/M1_BIAS_SENSOR
- MID_EXP_EPIX/PSC/M1_LV_ILOCK
- MID_EXP_EPIX/PSC/M1_BIAS_ILOCK
- MID_EXP_EPIX/PSC/M2_LV_ANALOG
- MID_EXP_EPIX/PSC/M2_LV_DIGITAL
- MID_EXP_EPIX/PSC/M2_BIAS_SENSOR
- MID_EXP_EPIX/PSC/M2_LV_ILOCK
- MID_EXP_EPIX/PSC/M2_BIAS_ILOCK

These names must be mapped into the MID_EXP_BIAS name set before detector installation and the power group names (e.g. SENSOR and ELECTRONICS, HV and LV…) for coupled operation of same functionality channels defined.

Interlock rules, see below, require that LV sense lines be input (high impedance) into the interlock PLC to allow HV disabling when LV is OFF. This input will be a separate 2-wire cable from the flange connector to the Beckhoff terminal. The power connector at the flange must have large cross-section conductor for the 12V and 12V-return power lines (at least 2mm*2). The connector must be designed have 12V and 12V-return, 12V-sense and 12V-sense-return, AND 12V and return to the PLC.

##### Cooling

Module cooling criteria are specified to be

Cooling |  |
--- | --- | ---
cooling agent | H2O | DI water
temperature range | 15-25°C |
temperature stability | <0.1 °C | Chiller specification, no temp regulation at detector needed
max pressure | <4.07 bar | depends on the housing design
min flow rate | 24L/h |
total cooling power | ? W | 20 Watts ASIC and Sensor region
cooling line diameter | >? | diameter of cooling line
connectors | VCR | Are these Quick lock, Swagelok?

Three (T1, T2 and T3) PT100 2-wire temperature sensors will be attached to the detector during assembly. These will be directly wired to the PLC interlock’s Beckhoff terminals. The cooling system will be described in a different CRD, e.g. MID_EXP_CHILL.

Thermal control:

In addition to water cooling of the camera body and readout system, the ePix100A camera employs a thermoelectric cooling (TEC) module (Peltier module, model TE-127-1.4-1.5, TE Technology, Inc.). The Pins 23/14 on the camera power/trigger DB26 connector are connected directly to a spare thermistor and can be used for fast temperature monitoring and adjustment using an external 10 V, 3 A thermoelectric device controller, such as the TED4015 from Thorlabs, https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=3512. Ideally, controller outputs are interlocked with the camera power supply to shut down the camera if temperatures are out of safe ranges. The detailed requirements for the TEC power supply are given in the table below.

TEC power supply |  |
--- | --- | ---
voltage | 10V | Peltier module, model TE-127-1.4-1.5, TE Technology, Inc.
Imax | 4A |
TEC controller | TED4015 | available from Thorlabs
temp stability at sensor | <5 mK | required temp stability to achieve detector performance as specified
operation range | -20 to +30C |

Use of a commercial PID TEC controller is strongly recommended. Constant power supply to the TEC module without feedback control is neither stable nor safe. The TED4015 will be controlled over Ethernet, similarly to Lakeshore devices, using SCPI protocol which requires connecting the USB bus to IP – currently foreseen is a USB to Serial to Ethernet conversion route.

When operating in atmosphere, at 15 °C, current limited to 2 A. At 5 °C the current is limited to 3 A.

The following PID algorithm parameters are used by the manufacturer P: 2.8, I: 8.3, D: 0.242

Currently the Meerstetter TEC-1091(https://www.meerstetter.ch/de/products/tec-controllers/tec-1091) is under investigation to be integrated into the XFEL control system.

##### Interlock

When conditions are “unsafe” for operation an interlock PLC (IL-PLC) drives modules into a safe configuration.

The unsafe conditions which can be foreseen lead to the following rules:

- Externally supplied HV must be off when LV is OFF (HV ON with LV OFF is not useful.)
- During in-vacuum module operation the HV must be OFF when vacuum pressure is between 0.1 and 100mBar.
- LV must be OFF if temperatures on the module are too high due to missing or insufficient cooling performance.
- LV must be OFF if the relative humidity is above the dew point.

Standard operation procedures must be applied to avoid sensor (with or w/o BIAS voltage applied) damage when hit by direct intense beam.

Required inputs (originate from sense points in the immediate neighbourhood of the module) into IL-PLC are:

- T1, T2, T3 temperature sensors mounted on the module (they are not provided on the modules delivered by the supplier)
- P pressure gauge which is part of the pressure chamber (see MID_EXP_???) in which the modules operate.
- V voltage at the SMC connector of the modules.

Required outputs (terminating at MID_EXP_BIAS) from IL-PLC are:

- ILOCK_LV, ILOCK_HV Interlock signals (see ILOCK definitions above) to disable LV and HV.

Required interlock (IL-PLC) response time is a few milliseconds.

The following table defines how the interlock should operate for a single module. For a two module detector simply add in additional T1, T2 and T3 sensors. Note that the rule “bP and bT and bV” of not being able to switch HV to ON when LV is OFF requires the V input to IL-PLC.

##### Sub-Components

###### CAL

CORR_OFFSET

Instance id: | MID_EXP_EPIX-1/CAL/CORR_OFFSET
Class id: | OffsetCorrectionEpix
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | EPIX-1-NEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

MANAGER

Instance id: | MID_EXP_EPIX-1/CAL/MANAGER
Class id: | CalManager
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/karaboDevices/calPy
Last modified: | 2021-09-30T14:30:36.393+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.2.1-2.10.0-test3
Deployment tag: | 2.2.1-2.10.0-test3
Installed tag: | 2.2.0-2.10.0
Scenes: | EPIX-2-NEW, EPIX-1-NEW, EPIX-ALL, CAL_PIPELINE_OVERVIEW, EPIX1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.2.0-2.10.0) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

###### DET

BKGSUB

Instance id: | MID_EXP_EPIX-1/DET/BKGSUB
Class id: | ImageBackgroundSubtraction
Host: | exflcon147
Alias: | mid-rr-sys-con-7
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: | EPIX-1-BKGSUB
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Background Subtraction

The `ImageBackgroundSubtraction` device is part of the imageProcessor package, and is documented in imageprocessor:image-background-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.
- disable:
    Disable background subtraction.
- imageFilename:
    The full filename to the background image. File format must be ‘npy’, ‘raw’ or TIFF.
- resetBackgroundImage:
    Reset background image.
- save:
    Save to file the current image.
- load:
    Load a background image from file.
- useAsBackgroundImage:
    Use the current image as background image.

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.

CONTROL

Instance id: | MID_EXP_EPIX-1/DET/CONTROL
Host: | exflcon147
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixControl
Last modified: | 2020-01-29T16:07:27.000+01:00
Created at: | 2017-02-14T12:01:16.000+01:00
Main authors: | Parenti, Mekinda
Latest tag: | 1.0.1-2.3.7
Deployment tag: | 1.0.1-2.3.7
Scenes: | EPIX-1, EPIX-1-NEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

[add instance documentation]

Release History
1.0.1-2.3.7

Created: | 2019-08-19T09:36:48.000Z
Author: | Andrea Parenti
Notes: | snapshot from master, which seems to have been deployed at hed

1.0.0-2.3.7

Created: | 2019-03-29T13:49:52.000Z
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3

1.0.0rc1-2.3.7

Created: | 2019-03-21T09:54:13.000Z
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3

0.3-2.2.4

Created: | 2018-07-06T07:43:40.000Z
Author: | Andrea Parenti
Notes: | Add tests and CI configuration Add DEPENDS file

0.2-2.2.3

Created: | 2018-06-11T10:27:13.000Z
Author: | Andrea Parenti
Notes: | Make ePixBoard parameters reconfigurable Add softReset/hardReset SLOTS

0.1-2.2.1

Created: | 2017-10-24T13:15:54.000Z
Author: | Leonce Mekinda
Notes: | First version

RECEIVER

Instance id: | MID_EXP_EPIX-1/DET/RECEIVER
Class id: | EPixReceiver
Host: | exflcon147
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixReceiver
Last modified: | 2020-11-30T15:33:00.000+01:00
Created at: | 2017-02-14T12:02:02.000+01:00
Main authors: | Fabbri, Haufs, Parenti
Latest tag: | 1.0.2-2.10.0
Deployment tag: | 1.0.2-2.10.0
Scenes: | EPIX-1, EPIX-1-NEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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
- device:
    The PGP card device file.
- backTemp:
    Strong back cold side temperature.
- ambTemp:
    Ambient temperature.
- relHumidity:
    Relative Humidity.
- analogCurr:
    ASIC analog current.
- digitalCurr:
    ASIC digital current.
- guardCurr:
    Detector guard ring current.
- analogInputVolt:
    Analog input voltage.
- digitalInputVolt:
    Digital input voltage.
- pgpStatus:
    The PGP card status.
- rxConf:
    Configuration of the receiver.
- rxRate:
    Results of the rate test.

Release History
1.0.2-2.10.0

Created: | 2020-11-30T15:10:19.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.1-2.6.1-test

Created: | 2019-07-16T09:40:24.000Z
Author: | Andrea Parenti
Notes: |

1.0.0a1-2.3.7

Created: | 2019-03-21T09:56:38.000Z
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3 Make it fit for 120 Hx operation mode

0.3-2.2.4

Created: | 2018-11-05T10:46:49.000Z
Author: | Andrea Parenti
Notes: | Update epixPackage to 1.2.1p1-2.2.3

0.2-2.2.3

Created: | 2018-06-13T12:47:17.000Z
Author: | Andrea Parenti
Notes: | Add tests and CI config Code clean-up Update DEPENDS

0.1-2.2.1

Created: | 2018-03-01T16:05:42.000Z
Author: | Leonce Mekinda
Notes: | First version

###### MDL

POWER

Instance id: | MID_EXP_EPIX-1/MDL/POWER
Host: | exflcon147
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/powerProcedures
Last modified: | 2020-02-18T15:39:16.000+01:00
Created at: | 2019-01-02T08:42:30.000+01:00
Main authors: | Xctrl, Muennich
Latest tag: | 1.2.0rc1-2.7.1
Deployment tag: | 1.2.0rc1-2.7.1
Installed tag: | 1.1.4-2.6.1-EPIX-test-2
Scenes: | EPIX-POWER
Accessible by: | CONTROLS, DA, scholzma

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.1.4-2.6.1-EPIX-test-2) does not match tags mentioned in the deployment ([‘1.2.0rc1-2.7.1’])!

[add instance documentation]

Release History
1.2.0rc1-2.7.1

Created: | 2020-02-14T11:54:28.000Z
Author: | Andrea Parenti
Notes: | Add AGIPD power procedure

1.1.5-2.6.1

Created: | 2019-11-07T14:20:44.000Z
Author: | Astrid Muennich
Notes: | Feature complete and documented. Still to be tested with real detectors!

1.1.4-2.6.1-EPIX-test-2

Created: | 2019-10-23T08:28:20.000Z
Author: | Astrid Muennich
Notes: | Changed for further testing at MID

1.1.4-2.6.1-EPIX-test

Created: | 2019-10-18T10:07:43.000Z
Author: | Astrid Muennich
Notes: |

1.1.3-2.5.0_patch

Created: | 2019-07-25T08:20:03.000Z
Author: | Astrid Muennich
Notes: | Bug fix in fetch Sequence

1.1.1-2.5.0-pnccd_patch

Created: | 2019-07-25T08:16:42.000Z
Author: | Astrid Muennich
Notes: | Bug fix in fetch sequence

1.1.3-2.5.0

Created: | 2019-07-19T10:11:26.000Z
Author: | Astrid Muennich
Notes: |

1.1.1-2.5.0-pnccd

Created: | 2019-07-19T09:41:03.000Z
Author: | Astrid Muennich
Notes: | Only adapted timings with respect to previous tag 1.1.1.-2.4.0

1.1.2.-2.5.0-dssc

Created: | 2019-07-17T12:07:00.000Z
Author: | Astrid Muennich
Notes: | Tested at DSSC, changed behaviour of continue sequence

1.1.1-2.4.0

Created: | 2019-06-28T11:17:22.000Z
Author: | Astrid Muennich
Notes: |

1.1.0-2.4.0

Created: | 2019-06-24T08:26:31.000Z
Author: | Astrid Muennich
Notes: | Evaluation of booleans based on sequence checking, runs in background

1.0.0-2.4.0

Created: | 2019-05-20T12:49:55.000Z
Author: | Astrid Muennich
Notes: |

TAGGROUP

Instance id: | MID_EXP_EPIX-1/MDL/TAGGROUP
Class id: | TagGroup
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/mpod
Last modified: | 2020-11-24T12:17:30.000+01:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.2-2.10.0
Deployment tag: | 5.2.2-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices

Release History
5.2.2-2.10.0

Created: | 2020-11-24T07:19:01.000Z
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T15:53:16.000Z
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T14:56:55.000Z
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T06:47:34.000Z
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T08:58:57.000Z
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T10:03:13.000Z
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T11:50:05.000Z
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T09:54:22.000Z
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T21:19:39.000Z
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T06:14:37.000Z
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T08:58:18.000Z
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T08:43:24.000Z
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T06:45:03.000Z
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T11:58:01.000Z
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T14:25:51.000Z
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T09:48:53.000Z
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T08:22:50.000Z
Author: | Wajid Ehsan
Notes: |

4.0.1-2.1.15

Created: | 2017-09-04T10:17:24.000Z
Author: | Chen Xu
Notes: | fixed setup.py

###### TSYS

DAQ_TRG

Instance id: | MID_EXP_EPIX-1/TSYS/DAQ_TRG
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

RUN_TRG

Instance id: | MID_EXP_EPIX-1/TSYS/RUN_TRG
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### EPIX-2

#### ePix System Overview

##### System description

The ePIX100 1M detector (EPIX) is implemented by operating two 0.5Mpxl ePIX detectors (in parallel) as a combined unit. To avoid confusion the term module will be used in the remainder of this document when describing a 0.5Mpxl detector. The 1Mpsx EPIX detector to be implemented consists of two identical 0.5Mpxl modules: M1 and M2.

The Epix100A camera is a pixel sensor camera supplied by SLAC. The camera module consists of a sensor (front) plane and electronics to acquire and control the module. Sensors and electronics are mechanically connected together in a single box format, as shown below. This means that if the sensors are to be operated in-vacuum, then the entire module box must be in-vacuum.

Related sub-systems required to operate the camera are chiller, power, sequencing and trigger control, and readout as shown schematically below..

This documentation assumes that modules are operated in-vacuum and includes a description of the flange feedthrough.

Technical details referred to in this overview are extracted from the “ePix100A camera Handling, the Installation Guide” and “Calibration, Operations and Software Development Guide” both of which are available in preliminary form. Additional requirements are taken from a summary table defined with the manufacturer.

This detector requires external low voltage (LV) and high voltage (HV) supplies and an external control of the Peltier element (TEC). It also requires a PLC interlock to drive the detector into a safe state, see the interlock section below.

The remainder of the description has been split into the following sections:

- Connections per module
- Trigger
- Operation restrictions
- The power operator
- Cooling
- Interlock

##### Connections per module

All connections required to control, readout and cool a module are mounted on the back plate, see below.

Details of connections required for a single module:

- 1 x DB26 per module connector for power, sequencing, trigger and timing, and control IO

Pin assignment | Function | Notes
--- | --- | ---
1 | Unused TTL output | Leave open
2 | Digital ground |
3 | Unused TTL output | Leave open
4 | Digital ground |
5 | DAQ trigger input | 5.5V TTL, Polarity +, min pulse width 100ns.
6 | Digital bias ground |
7 | RUN trigger input | 5.5V TTL, Polarity +, min pulse width 100ns.
8 | Digital ground |
9 | Detector bias | 10V-200V DC 250uA, recommend 200VDC 250uA
10 | Analog ground | Tied to camera common analog ground
11 | Digital ground |
12 | Analog ground |
13 | Digital ground |
14 | Spare thermistor ground |
15 | Analog ground |
16 | Digital ground |
17 | TEC ground |
18 | Detector ground |
19 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
20 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
21 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
22 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
23 | Spare thermistor |
24 | Analog power | Analog 6V DC 4A, Stability <1mV rms/ 3mV p-p
25 | Digital power | Digital 6V DC 0.6A, Stability <1mV rms/ 3mV p-p
26 | TEC power | see special specs.

- 1 x SFP+ IP 10Gbit MMF for use with the DAQ readout network
- 2 x Swagelok quick connectors for cooling water circuit (1 off picture).

To simplify connecting many cables each with different, often large, connectors (LV and associated sense lines, BIAS, Peltier, etc.) to the DB26 plug of EPIX modules, connection boxes were implemented for single module, M1, and dual, M1 and M2, installations.

Additional details of fibers required for use with the DAQ network at EuXFEL are shown in the following table.

DAQ connection | Spec | Comment
--- | --- | ---
fibre cable | OM4 | 50x125mu gradient index, multi-mode-3.3
connector | LC-LC |
SFP+ module | 10G | provided by manufacturer (AFBR-57D9AMZ) Avago, 850nm

Image data readout is transferred from the camera to a remote PC with PGP protocol over a fibre and requires the PCIe card, shown below, to be installed in the PC plus s/w drivers provided by the manufacturer. Two SFP+ are required for a 1Mpxl detector, one for M1 and another for M2, leaving two unused ports on the PCIe board.

##### Trigger

Two trigger signals are specified by the provider and both have electrical characteristics shown in the table below. Signal IO is via the DB26 connector. The trigger signals specified: a RUN (pin 7) image capture in the front-end electronics and DAQ (pin 5) package and dispatch image data to the remote PC can be delivered to a module by the EuXFEL ETA (External Trigger Adapter) box - a single ETA box can drive up to 3 IO signals, thus two ETA boards are required to provide the 4 trigger lines for the two module 1Mpxl detector.

The train number and pulse numbers of data acquired are inserted into the dataflow by ITDM using a mechanism similar to that for other commercial cameras.

Trigger | Electrical characteristic | Comment
--- | --- | ---
signal | 5.5V TTL | triggers on positive slope?
Input impedance | 50 Ohm |
polarity | plus |
Slope | positive |
min pulse width | 100ns |
connector | DB26 |
trigger to event delay | 100us |

##### Operation restrictions

It is useful to know when damage can occur and the provider has defined the following restrictions

Operation condition | Max time w/o damage to modules
--- | ---
in-air, no cooling, no beam, 10Hz clocking | ?
in-vacuum, no cooling, no beam, 10Hz clocking | ?

##### Power

Module power requirements are summarized in the table below. Throughout the document LV is used when referring to voltage supplied to power module electronics (digital and analog) and HV or BIAS is used when referring to sensor bias voltage.

All voltages are supplied through the DB26 connector. The 1Mpxl detector requires 2 modules and therefore 2 sets of power lines. The suggested power supplies for the low voltage, both analogue and digital, is the Wiener 8016. The suggested power supply for the high voltage supply is Iseg EHS8405p_SHV. Both detector modules can be powered from a single power-supply module, (HV and LV respectively) which is beneficial for the implementation of the interlock.

Power | Value | Comment
--- | --- | ---
LV ANALOG (DC) | (+)6.0V | positive voltage, static
operation range | 4.5-6.6V |
Vpp ripple | <3mV |
Vrms ripple | <1.0mV |
line regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
load regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
Umax | 6.6V | threshhold when damage is expected
Imax | 4.0 A | power supply max value
connector type on module | DB26 +ve (pins 19, 21, 24) return (10, 12, 15) |
LV DIGITAL (DC) | (+)6.0V | positive voltage, static
operation range | 4.5-6.6V |
Vpp ripple | <3mV |
Vrms ripple | <1.0mV |
line regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
load regulation | <0.01% + 3mV; <0.1% + 3mA | +/- (% of output +offset)
Umax | 6.6V | threshhold when damage is expected
Imax | 2A | power supply max value
connector type on module | DB26 +ve (pins 20, 22, 25) return (11, 13, 16) |
HV BIAS (DC) | (+)200V | positive voltage, static
operation range | 100-220V | working range of power supply
Vpp ripple | <5mV |
Vrms ripple | <2mV | PSI operates at <1.5mV rms
line regulation | <0.01% |
load regulation | <0.01% + 100µV | +/- (% of output +offset)
Umin, Umax | 10V, 250V | threshhold when damage is expected, Biasing below 10V will eventually damage the ASIC
Imax | 250uA |
V up/down ramping | not needed | Is ramping of the sensor bias needed? If yes please specify speed [V/s]
connector type on module | DB26 +ve (pin 9) return (pin 6) |

Each module requires 2 x LV and 1 x HV channel and these will be supplied by the small detector and diode power system described in MID_EXP_BIAS which is capable of delivering the voltages defined and integrating these with a PLC driven interlock.

The CONTROL name of a voltage channel (2-wire) is ComponentName + “/PSC/” + ChannelName, thus for the two modules described in this note the CONTROL names are:

- MID_EXP_EPIX/PSC/M1_LV_ANALOG
- MID_EXP_EPIX/PSC/M1_LV_DIGITAL
- MID_EXP_EPIX/PSC/M1_BIAS_SENSOR
- MID_EXP_EPIX/PSC/M1_LV_ILOCK
- MID_EXP_EPIX/PSC/M1_BIAS_ILOCK
- MID_EXP_EPIX/PSC/M2_LV_ANALOG
- MID_EXP_EPIX/PSC/M2_LV_DIGITAL
- MID_EXP_EPIX/PSC/M2_BIAS_SENSOR
- MID_EXP_EPIX/PSC/M2_LV_ILOCK
- MID_EXP_EPIX/PSC/M2_BIAS_ILOCK

These names must be mapped into the MID_EXP_BIAS name set before detector installation and the power group names (e.g. SENSOR and ELECTRONICS, HV and LV…) for coupled operation of same functionality channels defined.

Interlock rules, see below, require that LV sense lines be input (high impedance) into the interlock PLC to allow HV disabling when LV is OFF. This input will be a separate 2-wire cable from the flange connector to the Beckhoff terminal. The power connector at the flange must have large cross-section conductor for the 12V and 12V-return power lines (at least 2mm*2). The connector must be designed have 12V and 12V-return, 12V-sense and 12V-sense-return, AND 12V and return to the PLC.

##### Cooling

Module cooling criteria are specified to be

Cooling |  |
--- | --- | ---
cooling agent | H2O | DI water
temperature range | 15-25°C |
temperature stability | <0.1 °C | Chiller specification, no temp regulation at detector needed
max pressure | <4.07 bar | depends on the housing design
min flow rate | 24L/h |
total cooling power | ? W | 20 Watts ASIC and Sensor region
cooling line diameter | >? | diameter of cooling line
connectors | VCR | Are these Quick lock, Swagelok?

Three (T1, T2 and T3) PT100 2-wire temperature sensors will be attached to the detector during assembly. These will be directly wired to the PLC interlock’s Beckhoff terminals. The cooling system will be described in a different CRD, e.g. MID_EXP_CHILL.

Thermal control:

In addition to water cooling of the camera body and readout system, the ePix100A camera employs a thermoelectric cooling (TEC) module (Peltier module, model TE-127-1.4-1.5, TE Technology, Inc.). The Pins 23/14 on the camera power/trigger DB26 connector are connected directly to a spare thermistor and can be used for fast temperature monitoring and adjustment using an external 10 V, 3 A thermoelectric device controller, such as the TED4015 from Thorlabs, https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=3512. Ideally, controller outputs are interlocked with the camera power supply to shut down the camera if temperatures are out of safe ranges. The detailed requirements for the TEC power supply are given in the table below.

TEC power supply |  |
--- | --- | ---
voltage | 10V | Peltier module, model TE-127-1.4-1.5, TE Technology, Inc.
Imax | 4A |
TEC controller | TED4015 | available from Thorlabs
temp stability at sensor | <5 mK | required temp stability to achieve detector performance as specified
operation range | -20 to +30C |

Use of a commercial PID TEC controller is strongly recommended. Constant power supply to the TEC module without feedback control is neither stable nor safe. The TED4015 will be controlled over Ethernet, similarly to Lakeshore devices, using SCPI protocol which requires connecting the USB bus to IP – currently foreseen is a USB to Serial to Ethernet conversion route.

When operating in atmosphere, at 15 °C, current limited to 2 A. At 5 °C the current is limited to 3 A.

The following PID algorithm parameters are used by the manufacturer P: 2.8, I: 8.3, D: 0.242

Currently the Meerstetter TEC-1091(https://www.meerstetter.ch/de/products/tec-controllers/tec-1091) is under investigation to be integrated into the XFEL control system.

##### Interlock

When conditions are “unsafe” for operation an interlock PLC (IL-PLC) drives modules into a safe configuration.

The unsafe conditions which can be foreseen lead to the following rules:

- Externally supplied HV must be off when LV is OFF (HV ON with LV OFF is not useful.)
- During in-vacuum module operation the HV must be OFF when vacuum pressure is between 0.1 and 100mBar.
- LV must be OFF if temperatures on the module are too high due to missing or insufficient cooling performance.
- LV must be OFF if the relative humidity is above the dew point.

Standard operation procedures must be applied to avoid sensor (with or w/o BIAS voltage applied) damage when hit by direct intense beam.

Required inputs (originate from sense points in the immediate neighbourhood of the module) into IL-PLC are:

- T1, T2, T3 temperature sensors mounted on the module (they are not provided on the modules delivered by the supplier)
- P pressure gauge which is part of the pressure chamber (see MID_EXP_???) in which the modules operate.
- V voltage at the SMC connector of the modules.

Required outputs (terminating at MID_EXP_BIAS) from IL-PLC are:

- ILOCK_LV, ILOCK_HV Interlock signals (see ILOCK definitions above) to disable LV and HV.

Required interlock (IL-PLC) response time is a few milliseconds.

The following table defines how the interlock should operate for a single module. For a two module detector simply add in additional T1, T2 and T3 sensors. Note that the rule “bP and bT and bV” of not being able to switch HV to ON when LV is OFF requires the V input to IL-PLC.

##### Sub-Components

###### CAL

CORR_OFFSET

Instance id: | MID_EXP_EPIX-2/CAL/CORR_OFFSET
Class id: | OffsetCorrectionEpix
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-20T23:08:45.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.9.1
Deployment tag: | 1.17.0-2.9.1
Scenes: | EPIX-2-NEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

MANAGER

Instance id: | MID_EXP_EPIX-2/CAL/MANAGER
Class id: | CalManager
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/karaboDevices/calPy
Last modified: | 2021-09-30T14:30:36.393+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.2.1-2.10.0-test3
Deployment tag: | 2.2.1-2.10.0-test3
Installed tag: | 2.2.0-2.10.0
Scenes: | EPIX-ALL, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.2.0-2.10.0) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

###### DET

CONTROL

Instance id: | MID_EXP_EPIX-2/DET/CONTROL
Class id: | EPix100aControl
Host: | mid-rr-sys-con-7
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/ePixControl
Last modified: | 2021-08-02T13:43:37.000+02:00
Created at: | 2017-02-14T12:01:16.000+01:00
Main authors: | Parenti, Hauf, Xctrl
Latest tag: | 1.1.0-2.10.0
Deployment tag: | 1.1.0-2.10.0
Installed tag: | 1.1.0-2.10.0
Scenes: | EPIX-2-NEW, EPIX-2-NEW, EPIX-ALL, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- softReset:
    Soft reset the ePix.
- hardReset:
    Hard reset the ePix.
- device:
    The PGP card device file.
- confFile:
    ePix detector configuration file.
- triggerMode:
    The ePIX trigger mode.
- runRate:
    Rate of acquisition triggering
- regConf:
    Register configuration.
- ePixBoard:
    ePixBoard

Release History
1.1.0-2.10.0

Created: | 2020-11-27T10:58:36.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * Add version info * Add gain configuration options for epix10k * Install PyQt via DEPENDS

1.0.1-2.3.7

Created: | 2019-08-19T11:36:48.000+02:00
Author: | Andrea Parenti
Notes: | snapshot from master, which seems to have been deployed at hed

1.0.0-2.3.7

Created: | 2019-03-29T14:49:52.000+01:00
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3

1.0.0rc1-2.3.7

Created: | 2019-03-21T10:54:13.000+01:00
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3

0.3-2.2.4

Created: | 2018-07-06T09:43:40.000+02:00
Author: | Andrea Parenti
Notes: | Add tests and CI configuration Add DEPENDS file

0.2-2.2.3

Created: | 2018-06-11T12:27:13.000+02:00
Author: | Andrea Parenti
Notes: | Make ePixBoard parameters reconfigurable Add softReset/hardReset SLOTS

0.1-2.2.1

Created: | 2017-10-24T15:15:54.000+02:00
Author: | Leonce Mekinda
Notes: | First version

RECEIVER

Instance id: | MID_EXP_EPIX-2/DET/RECEIVER
Class id: | EPixReceiver
Host: | mid-rr-sys-con-7
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/ePixReceiver
Last modified: | 2021-08-27T20:47:31.093+02:00
Created at: | 2017-02-14T12:02:02.000+01:00
Main authors: | Mamchykd, Fabbri, Haufs
Latest tag: | 1.0.5-2.10.0_epix10k_quick
Deployment tag: | 1.0.5-2.10.0_epix10k_quick
Installed tag: | 1.0.5-2.10.0_epix10k_quick
Scenes: | EPIX-2-NEW, EPIX-2-NEW, EPIX-ALL, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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
- device:
    The PGP card device file.
- backTemp:
    Strong back cold side temperature.
- ambTemp:
    Ambient temperature.
- relHumidity:
    Relative Humidity.
- analogCurr:
    ASIC analog current.
- digitalCurr:
    ASIC digital current.
- guardCurr:
    Detector guard ring current.
- analogInputVolt:
    Analog input voltage.
- digitalInputVolt:
    Digital input voltage.
- pgpStatus:
    The PGP card status.
- rxConf:
    Configuration of the receiver.
- rxRate:
    Results of the rate test.

Release History
1.0.5-2.10.0_epix10k_quick

Created: | 2021-06-07T18:45:33.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Update DEPENDS (ePixPackage: 3.0.3p2-2.7.0) in branch epix10k/quick_and_dirty in use in MID

1.0.4-2.10.0_epix10k_quick

Created: | 2020-12-08T18:14:01.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Update to 2.10 versioning in branch epix10k/quick_and_dirty in use in MID

1.0.3-2.10.0

Created: | 2020-12-01T20:09:11.000+01:00
Author: | Riccardo Fabbri
Notes: | dependency updated

1.0.2-2.10.0

Created: | 2020-11-30T16:10:19.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.1-2.6.1-test

Created: | 2019-07-16T11:40:24.000+02:00
Author: | Andrea Parenti
Notes: |

1.0.0a1-2.3.7

Created: | 2019-03-21T10:56:38.000+01:00
Author: | Andrea Parenti
Notes: | Update to rogue 3.0.3 Make it fit for 120 Hx operation mode

0.3-2.2.4

Created: | 2018-11-05T11:46:49.000+01:00
Author: | Andrea Parenti
Notes: | Update epixPackage to 1.2.1p1-2.2.3

0.2-2.2.3

Created: | 2018-06-13T14:47:17.000+02:00
Author: | Andrea Parenti
Notes: | Add tests and CI config Code clean-up Update DEPENDS

0.1-2.2.1

Created: | 2018-03-01T17:05:42.000+01:00
Author: | Leonce Mekinda
Notes: | First version

###### MDL

POWER

Instance id: | MID_EXP_EPIX-2/MDL/POWER
Host: | exflcon147
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/powerProcedures
Last modified: | 2020-02-18T15:39:16.000+01:00
Created at: | 2019-01-02T08:42:30.000+01:00
Main authors: | Xctrl, Muennich
Latest tag: | 1.2.0rc1-2.7.1
Deployment tag: | 1.2.0rc1-2.7.1
Installed tag: | 1.1.4-2.6.1-EPIX-test-2
Scenes: | EPIX-POWER
Accessible by: | CONTROLS, DA, scholzma

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.1.4-2.6.1-EPIX-test-2) does not match tags mentioned in the deployment ([‘1.2.0rc1-2.7.1’])!

[add instance documentation]

Release History
1.2.0rc1-2.7.1

Created: | 2020-02-14T11:54:28.000Z
Author: | Andrea Parenti
Notes: | Add AGIPD power procedure

1.1.5-2.6.1

Created: | 2019-11-07T14:20:44.000Z
Author: | Astrid Muennich
Notes: | Feature complete and documented. Still to be tested with real detectors!

1.1.4-2.6.1-EPIX-test-2

Created: | 2019-10-23T08:28:20.000Z
Author: | Astrid Muennich
Notes: | Changed for further testing at MID

1.1.4-2.6.1-EPIX-test

Created: | 2019-10-18T10:07:43.000Z
Author: | Astrid Muennich
Notes: |

1.1.3-2.5.0_patch

Created: | 2019-07-25T08:20:03.000Z
Author: | Astrid Muennich
Notes: | Bug fix in fetch Sequence

1.1.1-2.5.0-pnccd_patch

Created: | 2019-07-25T08:16:42.000Z
Author: | Astrid Muennich
Notes: | Bug fix in fetch sequence

1.1.3-2.5.0

Created: | 2019-07-19T10:11:26.000Z
Author: | Astrid Muennich
Notes: |

1.1.1-2.5.0-pnccd

Created: | 2019-07-19T09:41:03.000Z
Author: | Astrid Muennich
Notes: | Only adapted timings with respect to previous tag 1.1.1.-2.4.0

1.1.2.-2.5.0-dssc

Created: | 2019-07-17T12:07:00.000Z
Author: | Astrid Muennich
Notes: | Tested at DSSC, changed behaviour of continue sequence

1.1.1-2.4.0

Created: | 2019-06-28T11:17:22.000Z
Author: | Astrid Muennich
Notes: |

1.1.0-2.4.0

Created: | 2019-06-24T08:26:31.000Z
Author: | Astrid Muennich
Notes: | Evaluation of booleans based on sequence checking, runs in background

1.0.0-2.4.0

Created: | 2019-05-20T12:49:55.000Z
Author: | Astrid Muennich
Notes: |

TAGGROUP

Instance id: | MID_EXP_EPIX-2/MDL/TAGGROUP
Class id: | TagGroup
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/mpod
Last modified: | 2020-11-24T12:17:30.000+01:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.2-2.10.0
Deployment tag: | 5.2.2-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices

Release History
5.2.2-2.10.0

Created: | 2020-11-24T07:19:01.000Z
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T15:53:16.000Z
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T14:56:55.000Z
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T06:47:34.000Z
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T08:58:57.000Z
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T10:03:13.000Z
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T11:50:05.000Z
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T09:54:22.000Z
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T21:19:39.000Z
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T06:14:37.000Z
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T08:58:18.000Z
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T08:43:24.000Z
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T06:45:03.000Z
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T11:58:01.000Z
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T14:25:51.000Z
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T09:48:53.000Z
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T08:22:50.000Z
Author: | Wajid Ehsan
Notes: |

4.0.1-2.1.15

Created: | 2017-09-04T10:17:24.000Z
Author: | Chen Xu
Notes: | fixed setup.py

###### TSYS

DAQ_TRG

Instance id: | MID_EXP_EPIX-2/TSYS/DAQ_TRG
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

RUN_TRG

Instance id: | MID_EXP_EPIX-2/TSYS/RUN_TRG
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### EPIX

##### ASENS

###### M1_H1

Instance id: | MID_EXP_EPIX/ASENS/M1_H1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EPIX-1-SUBSYS, JF01-subsys, JF-subsys, JF01-subsys0, JF-subsys-new, EPIX-ALL, EPIX1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_H2

Instance id: | MID_EXP_EPIX/ASENS/M1_H2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EPIX-ALL, EPIX2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_LV_A

Instance id: | MID_EXP_EPIX/ASENS/M1_LV_A
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_LV_B

Instance id: | MID_EXP_EPIX/ASENS/M1_LV_B
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_LV_A

Instance id: | MID_EXP_EPIX/ASENS/M2_LV_A
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_LV_B

Instance id: | MID_EXP_EPIX/ASENS/M2_LV_B
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TSENS

###### M1_T1

Instance id: | MID_EXP_EPIX/TSENS/M1_T1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_T2

Instance id: | MID_EXP_EPIX/TSENS/M1_T2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_T3

Instance id: | MID_EXP_EPIX/TSENS/M1_T3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T1

Instance id: | MID_EXP_EPIX/TSENS/M2_T1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T2

Instance id: | MID_EXP_EPIX/TSENS/M2_T2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T3

Instance id: | MID_EXP_EPIX/TSENS/M2_T3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### PSC

###### M1_BIAS_SENSOR

Instance id: | MID_EXP_EPIX/PSC/M1_BIAS_SENSOR
Class id: | MpodAveragingHVGroup
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/mpod
Last modified: | 2020-08-21T13:33:18.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Parenti, Youngman, Muennich
Latest tag: | 5.2.1-2.7.0
Deployment tag: | 5.2.1-2.7.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

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
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.1-2.7.0

Created: | 2019-12-18T15:53:16.000Z
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T14:56:55.000Z
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T06:47:34.000Z
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T08:58:57.000Z
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T10:03:13.000Z
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T11:50:05.000Z
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T09:54:22.000Z
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T21:19:39.000Z
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T06:14:37.000Z
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T06:35:04.000Z
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T08:58:18.000Z
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T08:43:24.000Z
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T06:45:03.000Z
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T11:58:01.000Z
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T14:25:51.000Z
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T09:48:53.000Z
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T08:22:50.000Z
Author: | Wajid Ehsan
Notes: |

4.0.1-2.1.15

Created: | 2017-09-04T10:17:24.000Z
Author: | Chen Xu
Notes: | fixed setup.py

4.0.0-2.1.13

Created: | 2017-05-24T12:02:51.000Z
Author: | Steffen Hauf
Notes: |

###### M1_LV_ANALOG

MPOD Documentation

- Troubleshooting
- General mpod package documentation

###### M1_LV_DIGITAL

MPOD Documentation

- Troubleshooting
- General mpod package documentation

#### FASTADC

##### ADC

###### DESTEST

Instance id: | MID_EXP_FASTADC/ADC/DESTEST
Class id: | FastAdc
Host: | mid-rr-sys-utc-1
Class documentation:
| FastAdc
Alias: | exflutc210-mch , exflqr18963-mch
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: | Bubbles_prototype0, correlation, MID_EXP_DES/CON/MDL_CONTROL|power_scene, test, MID_EXP_MIRR-Main, Diamond_45MHz, ADC_SCENE, Diamond_Detector, Diamond_prototype, test, FullADCScene, PUMA_MAIN, PUMA_TEST, PUMA_NEW_CONTROLS, MID_MAIN, DES_Diamond_Detector, MIRRDiode, Diamond_Duolateral, TMP, UserMain, UserSupportingScene, MID_EXP_SAM/LODD, MID_SAE_PUMA/PROC/ADC_PROCESS|overview, MID_EXP_SAM/MPCDD
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, 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

#### IMG

##### AVG

###### ASTRO1

Instance id: | MID_EXP_IMG/AVG/ASTRO1
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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: | ASTRO_SCENE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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

###### ASTRO1

Instance id: | MID_EXP_IMG/CAM/ASTRO1
Class id: | AndorZylaCamera
Host: | exflcon170
Alias: | mid-rr-sys-con-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/andorZylaCamera
Last modified: | 2019-08-26T12:05:51.000+02:00
Created at: | 2019-01-09T16:08:19.000+01:00
Main authors: | Giovanetti, Mohacsi
Latest tag: | 1.2.5-2.5.0
Deployment tag: | 1.2.5-2.5.0
Scenes: | ASTRO_SCENE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- outputFrameRate:
    Output frame rate of Karabo device.
- cameraIp:
    The IP address of the camera.
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- pollInterval:
    The interval for polling the camera
- isStrict:
    If true, device goes in error if value is refused from the Hardware
- rebootRcs:
    Reboots the RCS camera controller. Useful after the camera has been power cycled (RCS must always boot AFTER the Zyla camera is powered up)
- acquisitionFrameRate:
    The actual frame rate as set from camera.
- isAcquiring:
    True when camera is acquiring (read from HW)
- exposureTime:
    The exposure time.
- isRunning:
    True when camera is running (read from HW)
- cycleMode:
    Continuous: keep acquiring until acquisition is stopped. Fixed: the camera acquires ‘FrameCount’images and stop automatically.
- frameCount:
    Number of frames to acquire when ‘Fixed’ cycle mode. Ignored in ‘Continuous’ mode.
- triggerMode:
    Configure the camera trigger mode.
- fanOnOff:
    Switch on/off camera fan.
- pixelEncoding:
    Configures the format of data stream.
- electronicShutteringMode:
    On-sensor electronic shuttering mode.For pulsed or fast moving images ‘Global’ shuttering is recommended. For the highest frame rates and best noise performance ‘Rolling’ is recommended.
- imageSizeBytes:
    Size of the image in bytes
- accumulateCount:
    Sets the number of images that should be summed to obtain each image in sequence.
- roiBinning:
    Sets up pixel binning on the camera.
- roiHorizBinning:
    Configures the Horizontal Binning of the sensor region of interest
- roiVerticalBinning:
    Configures the Vertical Binning of the sensor region of interest
- auxiliaryOutSource:
    Configures which signal appears on the auxiliary output pin.
- isFastROIFrameRateEnabled:
    Enables faster framerates at small ROIs.
- ioSelector:
    Selects the IO Pin that you subsequently wish to configure using the IO Invert Feature.
- isIoInverted:
    Indicates whether or not the operation of the IO Pin selected through the IO Selector Feature is inverted.
- isOverlap:
    Enables overlap readout mode.
- pixelReadoutRate:
    Configures the rate of pixel readout from the sensor.
- isSensorCoolingOn:
    Configures the state of the sensor cooling. Cooling is disabled by default at power up and must be enabled for the camera to achieve its target temperature.
- ShutterOutputMode:
    Controls the behavior of the shutter.
- shutterTransferTime:
    Sets the time at which the shutter will be opened before an exposure starts. Can be set between 0 and 100ms at 0.5ms steps. Only available whenever the ExternalTriggerMode is set to ‘Automatic’
- simplePreAmpGainControl:
    Wrapper Feature to simplify selection of the sensitivity and dynamic range options. This feature should be used as a replacement for the PreAmpGainControl feature as some of the options in the PreAmpGainControl feature are not supported on all cameras. Supported Bit Depth will be dependent on the camera. When changing PreAmpGainControl, the PixelEncoding feature will automatically adjust to a default setting for that PreAmpGainControl. For example, if the PreAmpGainControl feature is changed from ‘12-bit (low noise)’ to ‘16-bit (low noise & high well capacity)’ then the PixelEncoding feature will switch automatically to Mono16. This will only occur ifthe PixelEncoding is currently set to Mono12 or Mono12Packed. Similarly, PixelEncoding will switch automatically to either Mono12 or Mono12Packed when the PreAmpGainControl feature is changed from ‘16-bit (low noise & high well capacity)’ to ‘12-bit (low noise)’. When PixelEncoding is set to Mono32, it does not change when PreAmpGainControl is changed.
- isSpuriousNoiseFilterEnabled:
    Enables or Disables the Spurious Noise Filter
- isStaticBlemishCorrectionEnabled:
    Enables or Disables the Static Blemish Correction

Release History
1.2.5-2.5.0

Created: | 2019-08-20T11:19:58.000Z
Author: | Istvan Mohacsi
Notes: |

1.2.4-2.4.0

Created: | 2019-04-25T14:33:20.000Z
Author: | Gabriele Giovanetti
Notes: |

1.2.4-2.4.0-test-20190425

Created: | 2019-04-24T16:06:53.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.2-2.3.4

Created: | 2019-03-19T11:14:42.000Z
Author: | Gabriele Giovanetti
Notes: | Fixed ROI stride bug.

1.1.1-2.3.4

Created: | 2019-02-26T13:25:54.000Z
Author: | Gabriele Giovanetti
Notes: | various fixes

1.1.0-2.3.4

Created: | 2019-02-19T18:09:19.000Z
Author: | Gabriele Giovanetti
Notes: | Added reboot RCS slot

1.0.0-2.3.4

Created: | 2019-02-19T08:26:26.000Z
Author: | Gabriele Giovanetti
Notes: | First release

###### ZYLA

Instance id: | MID_EXP_IMG/CAM/ZYLA
Class id: | AndorZylaCamera
Host: | mid-rr-sys-con-12
Alias: | mid-rr-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/andorZylaCamera
Last modified: | 2019-08-26T12:05:51.000+02:00
Created at: | 2019-01-09T16:08:19.000+01:00
Main authors: | Giovanetti, Mohacsi
Latest tag: | 1.2.5-2.5.0
Deployment tag: | 1.2.5-2.5.0
Scenes: | test, ZYLA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Installation not found in a standard path!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- outputFrameRate:
    Output frame rate of Karabo device.
- cameraIp:
    The IP address of the camera.
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- pollInterval:
    The interval for polling the camera
- isStrict:
    If true, device goes in error if value is refused from the Hardware
- rebootRcs:
    Reboots the RCS camera controller. Useful after the camera has been power cycled (RCS must always boot AFTER the Zyla camera is powered up)
- imageLatency:
    The difference between image timestamp (got from RCS) and the ‘current’ timestamp (when the image is written to the output channels
- lostFramesRate:
    Average rate of lost frames
- rotation:
    The image rotation.
- acquisitionFrameRate:
    The actual frame rate as set from camera.
- isAcquiring:
    True when camera is acquiring (read from HW)
- exposureTime:
    The exposure time.
- isRunning:
    True when camera is running (read from HW)
- cycleMode:
    Continuous: keep acquiring until acquisition is stopped. Fixed: the camera acquires ‘FrameCount’images and stop automatically.
- frameCount:
    Number of frames to acquire when ‘Fixed’ cycle mode. Ignored in ‘Continuous’ mode.
- triggerMode:
    Configure the camera trigger mode.
- fanOnOff:
    Switch on/off camera fan.
- pixelEncoding:
    Configures the format of data stream.
- electronicShutteringMode:
    On-sensor electronic shuttering mode.For pulsed or fast moving images ‘Global’ shuttering is recommended. For the highest frame rates and best noise performance ‘Rolling’ is recommended.
- imageSizeBytes:
    Size of the image in bytes
- roi:
    ROI in displayed image coordinates (after rotation/flip)
- ccdRoi:
    ROI expressed in original sensor coordinates, i.e. before any rotation or flip is applied
- accumulateCount:
    Sets the number of images that should be summed to obtain each image in sequence.
- roiBinning:
    Sets up pixel binning on the camera.
- roiHorizBinning:
    Configures the Horizontal Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- roiVerticalBinning:
    Configures the Vertical Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- auxiliaryOutSource:
    Configures which signal appears on the auxiliary output pin.
- isFastROIFrameRateEnabled:
    Enables faster framerates at small ROIs.
- ioSelector:
    Selects the IO Pin that you subsequently wish to configure using the IO Invert Feature.
- isIoInverted:
    Indicates whether or not the operation of the IO Pin selected through the IO Selector Feature is inverted.
- isOverlap:
    Enables overlap readout mode.
- pixelReadoutRate:
    Configures the rate of pixel readout from the sensor.
- isSensorCoolingOn:
    Configures the state of the sensor cooling. Cooling is disabled by default at power up and must be enabled for the camera to achieve its target temperature.
- ShutterOutputMode:
    Controls the behavior of the shutter.
- shutterTransferTime:
    Sets the time at which the shutter will be opened before an exposure starts. Can be set between 0 and 100ms at 0.5ms steps. Only available whenever the ExternalTriggerMode is set to ‘Automatic’
- simplePreAmpGainControl:
    Wrapper Feature to simplify selection of the sensitivity and dynamic range options. This feature should be used as a replacement for the PreAmpGainControl feature as some of the options in the PreAmpGainControl feature are not supported on all cameras. Supported Bit Depth will be dependent on the camera. When changing PreAmpGainControl, the PixelEncoding feature will automatically adjust to a default setting for that PreAmpGainControl. For example, if the PreAmpGainControl feature is changed from ‘12-bit (low noise)’ to ‘16-bit (low noise & high well capacity)’ then the PixelEncoding feature will switch automatically to Mono16. This will only occur ifthe PixelEncoding is currently set to Mono12 or Mono12Packed. Similarly, PixelEncoding will switch automatically to either Mono12 or Mono12Packed when the PreAmpGainControl feature is changed from ‘16-bit (low noise & high well capacity)’ to ‘12-bit (low noise)’. When PixelEncoding is set to Mono32, it does not change when PreAmpGainControl is changed.
- isSpuriousNoiseFilterEnabled:
    Enables or Disables the Spurious Noise Filter
- isStaticBlemishCorrectionEnabled:
    Enables or Disables the Static Blemish Correction
- AOIStride:
    AOIStride
- Baseline:
    Baseline
- BitDepth:
    BitDepth
- BytesPerPixel:
    BytesPerPixel
- CameraModel:
    CameraModel
- CameraName:
    CameraName
- CameraPresent:
    CameraPresent
- ControllerID:
    ControllerID
- ExposedPixelHeight:
    ExposedPixelHeight
- ExternalTriggerDelay:
    ExternalTriggerDelay
- FirmwareVersion:
    FirmwareVersion
- FullAOIControl:
    FullAOIControl
- InterfaceType:
    InterfaceType
- LineScanSpeed:
    LineScanSpeed
- MaxInterfaceTransferRate:
    MaxInterfaceTransferRate
- PixelHeight:
    PixelHeight
- PixelWidth:
    PixelWidth
- ReadoutTime:
    ReadoutTime
- RowReadTime:
    RowReadTime
- SensorHeight:
    SensorHeight
- SensorTemperature:
    SensorTemperature
- SensorWidth:
    SensorWidth
- SerialNumber:
    SerialNumber
- SoftwareVersion:
    SoftwareVersion
- TemperatureStatus:
    TemperatureStatus
- TimestampClock:
    TimestampClock
- TimestampClockFrequency:
    TimestampClockFrequency

Release History
1.2.5-2.5.0

Created: | 2019-08-20T13:19:58.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.2.4-2.4.0

Created: | 2019-04-25T16:33:20.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.2.4-2.4.0-test-20190425

Created: | 2019-04-24T18:06:53.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.1.2-2.3.4

Created: | 2019-03-19T12:14:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Fixed ROI stride bug.

1.1.1-2.3.4

Created: | 2019-02-26T14:25:54.000+01:00
Author: | Gabriele Giovanetti
Notes: | various fixes

1.1.0-2.3.4

Created: | 2019-02-19T19:09:19.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added reboot RCS slot

1.0.0-2.3.4

Created: | 2019-02-19T09:26:26.000+01:00
Author: | Gabriele Giovanetti
Notes: | First release

##### PROC

###### ASTRO1

Instance id: | MID_EXP_IMG/PROC/ASTRO1
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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: | ASTRO_SCENE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.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.

##### MDL

[add component documentation]

###### ZYLA_TRIGGER

Instance id: | MID_EXP_IMG/MDL/ZYLA_TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### TSYS

[add component documentation]

###### ZYLA_TRIGGER

Instance id: | MID_EXP_IMG/TSYS/ZYLA_TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### JGFR1M

##### ASENS

###### M1_LV

Instance id: | MID_EXP_JGFR1M/ASENS/M1_LV
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_LV

Instance id: | MID_EXP_JGFR1M/ASENS/M2_LV
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TSENS

###### M1_T1

Instance id: | MID_EXP_JGFR1M/TSENS/M1_T1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_T2

Instance id: | MID_EXP_JGFR1M/TSENS/M1_T2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M1_T3

Instance id: | MID_EXP_JGFR1M/TSENS/M1_T3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T1

Instance id: | MID_EXP_JGFR1M/TSENS/M2_T1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T2

Instance id: | MID_EXP_JGFR1M/TSENS/M2_T2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### M2_T3

Instance id: | MID_EXP_JGFR1M/TSENS/M2_T3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

#### KAMZIK

##### ZMQSUB

###### KAMZIK_MOTORS

Instance id: | MID_EXP_KAMZIK/ZMQSUB/KAMZIK_MOTORS
Host: | exflcon143
Alias: | mid-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/UPEX2200ExternalMotors
Last modified: | 2019-04-11T16:00:05.000+02:00
Created at: | 2019-04-04T15:39:25.000+02:00
Main authors: | Michelat
Latest tag: | 1.0.0-2.4.0
Deployment tag: | 1.0.0-2.4.0
Installed tag: | 1.0.0-2.4.0
Accessible by: | CONTROLS, DA, scholzma

Warning

Rogue installation which is not mentioned in the deployment!

#### LDM

##### SWITCH

###### SPARE1

Instance id: | MID_EXP_LDM/SWITCH/SPARE1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### SPARE2

Instance id: | MID_EXP_LDM/SWITCH/SPARE2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW1

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW2

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW3

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW4

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW4
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW5

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW5
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW6

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW6
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW7

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW7
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CONF_SW8

Instance id: | MID_EXP_LDM/SWITCH/CONF_SW8
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CT_RY

Instance id: | MID_EXP_LDM/SWITCH/CT_RY
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TY

Instance id: | MID_EXP_LDM/SWITCH/DCS_TY
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_HS1

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_HS1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_PAD1_LO

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_PAD1_LO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_PAD2_LO

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_PAD2_LO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB1_PRESOSTAT_1

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB1_PRESOSTAT_1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB1_PRESOSTAT_2

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB1_PRESOSTAT_2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB1_SSTO

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB1_SSTO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB2_PRESOSTAT_1

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB2_PRESOSTAT_1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB2_PRESOSTAT_2

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB2_PRESOSTAT_2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB2_SSTO

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB2_SSTO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB3_PRESOSTAT_1

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB3_PRESOSTAT_1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB3_PRESOSTAT_2

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB3_PRESOSTAT_2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### DCS_TZ_SB3_SSTO

Instance id: | MID_EXP_LDM/SWITCH/DCS_TZ_SB3_SSTO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### LDM_RY

Instance id: | MID_EXP_LDM/SWITCH/LDM_RY
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_DTZ_SS1

Instance id: | MID_EXP_LDM/SWITCH/TFT_DTZ_SS1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_DTZ_SS2

Instance id: | MID_EXP_LDM/SWITCH/TFT_DTZ_SS2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_DTZ_SS3

Instance id: | MID_EXP_LDM/SWITCH/TFT_DTZ_SS3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_UTZ_SS1

Instance id: | MID_EXP_LDM/SWITCH/TFT_UTZ_SS1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_UTZ_SS2D

Instance id: | MID_EXP_LDM/SWITCH/TFT_UTZ_SS2D
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_UTZ_SS2U

Instance id: | MID_EXP_LDM/SWITCH/TFT_UTZ_SS2U
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_UTZ_SS3

Instance id: | MID_EXP_LDM/SWITCH/TFT_UTZ_SS3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TFT_UTZ_SS4

Instance id: | MID_EXP_LDM/SWITCH/TFT_UTZ_SS4
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TY1

Instance id: | MID_EXP_LDM/SWITCH/TY1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### TY2

Instance id: | MID_EXP_LDM/SWITCH/TY2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### ESTOP

Instance id: | MID_EXP_LDM/SWITCH/ESTOP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### MODE_ALIGNMENT

Instance id: | MID_EXP_LDM/SWITCH/MODE_ALIGNMENT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### MODE_GENERAL

Instance id: | MID_EXP_LDM/SWITCH/MODE_GENERAL
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### RESET_REQUIRED

Instance id: | MID_EXP_LDM/SWITCH/RESET_REQUIRED
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

##### DCTRL

[add component documentation]

###### DCS_TZ_PAD1_COIL

Instance id: | MID_EXP_LDM/DCTRL/DCS_TZ_PAD1_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### DCS_TZ_PAD2_COIL

Instance id: | MID_EXP_LDM/DCTRL/DCS_TZ_PAD2_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### DCS_TZ_SB1_COIL

Instance id: | MID_EXP_LDM/DCTRL/DCS_TZ_SB1_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### DCS_TZ_SB2_COIL

Instance id: | MID_EXP_LDM/DCTRL/DCS_TZ_SB2_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### DCS_TZ_SB3_COIL

Instance id: | MID_EXP_LDM/DCTRL/DCS_TZ_SB3_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

[add component documentation]

###### PG1

Instance id: | MID_EXP_LDM/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_LDM/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_LDM/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_LDM/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG5

Instance id: | MID_EXP_LDM/GAUGE/PG5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG6

Instance id: | MID_EXP_LDM/GAUGE/PG6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG7

Instance id: | MID_EXP_LDM/GAUGE/PG7
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

[add component documentation]

###### CT_RY

###### DCS_TY

###### DCS_TZ_1

Instance id: | MID_EXP_LDM/MOTOR/DCS_TZ_1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM/MOTOR/DCS_TZ_1|commMotorScene, MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### DCS_TZ_2

Instance id: | MID_EXP_LDM/MOTOR/DCS_TZ_2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM/MOTOR/DCS_TZ_2|commMotorScene, MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### LDM_RY

###### TFT_DTY1

###### TFT_DTY2

###### TFT_DTY3

###### TFT_UTY1

###### TFT_UTY2

###### TFT_UTY3

###### TFT_UTY4

###### TFT_UTY5

###### TFT_UTZ

Instance id: | MID_EXP_LDM/MOTOR/TFT_UTZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM/MOTOR/TFT_UTZ|commMotorScene, MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

##### TPUMP

[add component documentation]

###### TP1

Instance id: | MID_EXP_LDM/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP2

Instance id: | MID_EXP_LDM/TPUMP/TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

[add component documentation]

###### AV1

Instance id: | MID_EXP_LDM/VALVE/AV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### AV2

Instance id: | MID_EXP_LDM/VALVE/AV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### DCS_TY_SB1

Instance id: | MID_EXP_LDM/VALVE/DCS_TY_SB1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV1

Instance id: | MID_EXP_LDM/VALVE/GV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV2

Instance id: | MID_EXP_LDM/VALVE/GV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### LDM_PAD1

Instance id: | MID_EXP_LDM/VALVE/LDM_PAD1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### LDM_PAD2

Instance id: | MID_EXP_LDM/VALVE/LDM_PAD2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### LDM_RY_CYLTY

Instance id: | MID_EXP_LDM/VALVE/LDM_RY_CYLTY
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TFT_UTZ_SB1

Instance id: | MID_EXP_LDM/VALVE/TFT_UTZ_SB1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### VDCTRL

[add component documentation]

###### SAFETY_ERRACK

Instance id: | MID_EXP_LDM/VDCTRL/SAFETY_ERRACK
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_LDM_Control_Panel, MID_EXP_LDM/VDCTRL/SAFETY_ERRACK|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SAFETY_RUN

Instance id: | MID_EXP_LDM/VDCTRL/SAFETY_RUN
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### VSWITCH

[add component documentation]

###### RESET_BUTTON

Instance id: | MID_EXP_LDM/VSWITCH/RESET_BUTTON
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

#### LSHAPE

##### MOTOR

###### CB800_R1

###### CB800_R2

###### CB800_T1

###### TREACY1

Instance id: | MID_EXP_LSHAPE/MOTOR/TREACY1
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### TREACY2

Instance id: | MID_EXP_LSHAPE/MOTOR/TREACY2
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

#### MIRR

##### ACTRL

###### MIRR1_PITCH

Instance id: | MID_EXP_MIRR/ACTRL/MIRR1_PITCH
Class id: | BeckhoffAnalogOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### MIRR2_PITCH

Instance id: | MID_EXP_MIRR/ACTRL/MIRR2_PITCH
Class id: | BeckhoffAnalogOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ASENS

###### MIRR1_PITCH

Instance id: | MID_EXP_MIRR/ASENS/MIRR1_PITCH
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### MIRR2_PITCH

Instance id: | MID_EXP_MIRR/ASENS/MIRR2_PITCH
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### DCTRL

###### CRYO

Instance id: | MID_EXP_MIRR/DCTRL/CRYO
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG1

Instance id: | MID_EXP_MIRR/DCTRL/PG1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_MIRR/DCTRL/PG2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_MIRR/DCTRL/SPARE_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B1

Instance id: | MID_EXP_MIRR/DCTRL/SPARE_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_MIRR/DCTRL/SPARE_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_C2

Instance id: | MID_EXP_MIRR/DCTRL/SPARE_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### MIRR1_PITCH

Instance id: | MID_EXP_MIRR/ENC/MIRR1_PITCH
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### MIRR2_PITCH

Instance id: | MID_EXP_MIRR/ENC/MIRR2_PITCH
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG1

Instance id: | MID_EXP_MIRR/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_MIRR/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR-Main, EXP_main_Vacuum_scene, EXP_main_Vacuum_scene, MIRR_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_MIRR/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B1

Instance id: | MID_EXP_MIRR/GAUGE/SPARE_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_MIRR/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_C2

Instance id: | MID_EXP_MIRR/GAUGE/SPARE_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ICTRL

###### IPCTRL

Instance id: | MID_EXP_MIRR/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_EXP_MIRR/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### IP2

Instance id: | MID_EXP_MIRR/IPUMP/IP2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### MOTOR

###### DIODEX

###### DIODEY

###### MIRR1_ROLL

###### MIRR2_ROLL

###### MIRR_TX

###### MIRR_TYD

###### MIRR_TYU

###### SLIT1Y

###### SLIT2Y

###### MIRR1_SM_PITCH

###### MIRR2_SM_PITCH

##### TSENS

###### PT1

Instance id: | MID_EXP_MIRR/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT10

Instance id: | MID_EXP_MIRR/TSENS/PT10
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT11

Instance id: | MID_EXP_MIRR/TSENS/PT11
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT12

Instance id: | MID_EXP_MIRR/TSENS/PT12
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT13

Instance id: | MID_EXP_MIRR/TSENS/PT13
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT14

Instance id: | MID_EXP_MIRR/TSENS/PT14
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT15

Instance id: | MID_EXP_MIRR/TSENS/PT15
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT16

Instance id: | MID_EXP_MIRR/TSENS/PT16
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT17

Instance id: | MID_EXP_MIRR/TSENS/PT17
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT2

Instance id: | MID_EXP_MIRR/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT3

Instance id: | MID_EXP_MIRR/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT4

Instance id: | MID_EXP_MIRR/TSENS/PT4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT5

Instance id: | MID_EXP_MIRR/TSENS/PT5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT6

Instance id: | MID_EXP_MIRR/TSENS/PT6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT7

Instance id: | MID_EXP_MIRR/TSENS/PT7
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT8

Instance id: | MID_EXP_MIRR/TSENS/PT8
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT9

Instance id: | MID_EXP_MIRR/TSENS/PT9
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_MIRR_TEMPERATURE_MONITOR, MID_EXP_MIRR_TEMPERATURE_GRAPHS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### VALVE

###### GVU

Instance id: | MID_EXP_MIRR/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### 2

Instance id: | MID_EXP_MIRR/2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

###### 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

#### NAFO

##### MOTOR

###### IMX

Instance id: | MID_EXP_NAFO/MOTOR/IMX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### IMY

Instance id: | MID_EXP_NAFO/MOTOR/IMY
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### IMZ

Instance id: | MID_EXP_NAFO/MOTOR/IMZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### PPX

Instance id: | MID_EXP_NAFO/MOTOR/PPX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### PPY

Instance id: | MID_EXP_NAFO/MOTOR/PPY
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### PPZ

Instance id: | MID_EXP_NAFO/MOTOR/PPZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

##### TSENS

###### TS1

Instance id: | MID_EXP_NAFO/TSENS/TS1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS2

Instance id: | MID_EXP_NAFO/TSENS/TS2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

#### P

##### CTRL

###### FEEDBACK_PID_TEST

Instance id: | MID_EXP_P/CTRL/FEEDBACK_PID_TEST
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/feedbackPid
Last modified: | 2019-08-30T17:02:14.000+02:00
Created at: | 2016-12-22T15:10:59.000+01:00
Main authors: | Schaffer, Mekinda, Ehsan
Latest tag: | 2.0.2-2.6.1
Deployment tag: | 2.0.0-2.6.1
Installed tag: | 2.0.2-2.6.1
Scenes: | TEST
Accessible by: | CONTROLS, DA, scholzma

Warning

The installed tag (2.0.2-2.6.1) does not match tags mentioned in the deployment ([‘2.0.0-2.6.1’])!

#### P2335

##### TEST

###### THERMAL_LOAD

#### ROUGH

##### GAUGE

###### PG1

Instance id: | MID_EXP_ROUGH/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_ROUGH/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_ROUGH/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_ROUGH/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG5

Instance id: | MID_EXP_ROUGH/GAUGE/PG5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### VS_GROUP

Instance id: | MID_EXP_ROUGH/MDL/VS_GROUP
Class id: | VacuumSectionGroup
Host: | exflcon138
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/vacuumSection
Last modified: | 2020-11-24T12:51:45.000+01:00
Created at: | 2016-11-16T14:10:37.000+01:00
Main authors: | Haufs, Schaffer, Ehsan
Latest tag: | 2.1.8-2.10.0
Deployment tag: | 2.1.8-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- poll_policy:
    Poll policy of ion-pump and gauge device properties
- reset_vacuum_sections:
    Resets vacuum section devices in ERROR and requests their h/w values from PLC

Release History
2.1.8-2.10.0

Created: | 2020-11-24T11:51:57.000Z
Author: | Wajid Ehsan
Notes: | Update Version Info

2.1.7-2.5.0

Created: | 2019-07-16T15:12:15.000Z
Author: | Christopher Youngman
Notes: | added turbo pumps device and table

2.1.6-2.4.0

Created: | 2019-07-03T10:26:24.000Z
Author: | Christopher Youngman
Notes: | Adds INITONLY settable time between requests property and some bookkeeping with it to avoid/see KaraboError occurances.

2.1.5-2.4.0

Created: | 2019-07-02T13:07:15.000Z
Author: | Christopher Youngman
Notes: | Catches KaraboError exception and continues if VacuumSection ‘reset’ and ‘request_hw_values’ slot calls throw the exception.

2.1.4-2.4.0

Created: | 2019-05-27T09:07:24.000Z
Author: | Christopher Youngman
Notes: | Adds additional MDL device above the VacuumSection called VacuumSectionGroup, whose table element lists VacuumSetction to receive ‘Reset’ followed by ‘Request h/w values’ when ‘Force Refresh’ is fired.

2.1.3-2.4.0

Created: | 2019-05-09T13:53:20.000Z
Author: | Robert Schaffer
Notes: | Added units to the agilent ion-pump properties

2.1.2-2.3.2

Created: | 2019-01-11T15:12:52.000Z
Author: | Robert Schaffer
Notes: | Added a workaround for the table-element bug, which is to be addressed in karabo-2.3.3. Also improved error handling for this table element (may be also handled by the bugfix).

2.1.1-2.2.5

Created: | 2018-10-15T12:01:43.000Z
Author: | Valerii Bondar
Notes: | Version with scene generation. Was successfully tested in tunnel.

2.1.0-2.2.4

Created: | 2018-03-27T12:08:25.000Z
Author: | Dennis Goeries
Notes: | Device Scene added

2.0.5-2.2.1

Created: | 2018-02-16T09:55:20.000Z
Author: | Christopher Youngman
Notes: | Remove superfluous state set

2.0.4-2.2.1

Created: | 2018-02-05T14:42:06.000Z
Author: | Christopher Youngman
Notes: | Exposes aggregated ion-pump and guage alarm and state as those of the VS device

2.0.3-2.1

Created: | 2017-06-20T07:51:51.000Z
Author: | Dennis Goeries
Notes: |

2.0

Created: | 2016-12-12T18:08:12.000Z
Author: | Alessandro Silenzi
Notes: | running version with karabo 2.0. This is tagged for old compatiblity since a new version is coming up.

2.0.2-1.4

Created: | 2016-11-30T09:02:37.000Z
Author: | Wajid Ehsan
Notes: | version 1.4

0.1.0-1.4

Created: | 2016-11-04T15:04:02.000Z
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/0.1.0-1.4” via karabo script

tags

Created: | 2016-11-04T14:17:55.000Z
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/tags/0.1.0-1.4” via karabo script

##### PUMP

###### RP1

Instance id: | MID_EXP_ROUGH/PUMP/RP1
Class id: | BeckhoffGeneric
Host: | mid-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
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.5-2.11.1
Scenes: | Rough
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.

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

###### RP2

Instance id: | MID_EXP_ROUGH/PUMP/RP2
Class id: | BeckhoffGeneric
Host: | mid-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
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.5-2.11.1
Scenes: | Rough
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.

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

##### TPUMP

###### TP1

Instance id: | MID_EXP_ROUGH/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP2

Instance id: | MID_EXP_ROUGH/TPUMP/TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP3

Instance id: | MID_EXP_ROUGH/TPUMP/TP3
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP4

Instance id: | MID_EXP_ROUGH/TPUMP/TP4
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

##### DCTRL

###### PG2_HIGH

Instance id: | MID_EXP_ROUGH/DCTRL/PG2_HIGH
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2_LOW

Instance id: | MID_EXP_ROUGH/DCTRL/PG2_LOW
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### SWITCH

###### PG2_HIGH

Instance id: | MID_EXP_ROUGH/SWITCH/PG2_HIGH
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### PG2_LOW

Instance id: | MID_EXP_ROUGH/SWITCH/PG2_LOW
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

#### SAM

##### AVG

###### CAM1

Instance id: | MID_EXP_SAM/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, MID_EXP_SAM/CAM/CAM1_detail, MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM2

Instance id: | MID_EXP_SAM/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, MID_EXP_SAM/CAM/CAM2_detail, MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM3

Instance id: | MID_EXP_SAM/AVG/CAM3
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, MID_EXP_SAM/CAM/CAM3_detail, MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM4

Instance id: | MID_EXP_SAM/AVG/CAM4
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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

###### CAM1

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

###### CAM2

GENICAM CAMERAS

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

###### CAM3

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

###### CAM4

GENICAM CAMERAS

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

###### CAM5

GENICAM CAMERAS

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

##### MOTOR

###### BSTX

Instance id: | MID_EXP_SAM/MOTOR/BSTX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, UPP_slits, UPP_slits_test0, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### BSTY

Instance id: | MID_EXP_SAM/MOTOR/BSTY
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### BSTZ

Instance id: | MID_EXP_SAM/MOTOR/BSTZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | speckle, MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### LOTZ

###### PHTX

Instance id: | MID_EXP_SAM/MOTOR/PHTX
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### PHTY

Instance id: | MID_EXP_SAM/MOTOR/PHTY
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### PHTZ

Instance id: | MID_EXP_SAM/MOTOR/PHTZ
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM/allMotors_backup, MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, MID_EXP_SAM_MOTORS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### SSRY

###### SSTY

###### TY1

###### TY2

###### LOTX

##### PROC

###### CAM1

Instance id: | MID_EXP_SAM/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, MID_EXP_SAM/CAM/CAM1_detail, BeamPosition
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### CAM2

Instance id: | MID_EXP_SAM/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, BeamPosition, MID_EXP_SAM/CAM/CAM2_detail
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### CAM3

Instance id: | MID_EXP_SAM/PROC/CAM3
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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: | MID_EXP_SAM/CAM/ALL_CAMS, MID_EXP_SAM/CAM/CAM3_detail, BeamPosition
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### CAM4

Instance id: | MID_EXP_SAM/PROC/CAM4
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

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.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.

##### SWITCH

###### LOTX_HOME

Instance id: | MID_EXP_SAM/SWITCH/LOTX_HOME
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CR1_LO

Instance id: | MID_EXP_SAM/SWITCH/CR1_LO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### CR2_LO

Instance id: | MID_EXP_SAM/SWITCH/CR2_LO
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

##### TSENS

###### PT1

Instance id: | MID_EXP_SAM/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT2

Instance id: | MID_EXP_SAM/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT3

Instance id: | MID_EXP_SAM/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT4

Instance id: | MID_EXP_SAM/TSENS/PT4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT5

Instance id: | MID_EXP_SAM/TSENS/PT5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TRIGGER_CAM1

Instance id: | MID_EXP_SAM/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_EXP_SAM/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM3

Instance id: | MID_EXP_SAM/TSYS/TRIGGER_CAM3
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM4

Instance id: | MID_EXP_SAM/TSYS/TRIGGER_CAM4
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM5

Instance id: | MID_EXP_SAM/TSYS/TRIGGER_CAM5
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### HEXAPOD

###### LOHEX

###### SSHEX

##### ZEROMQ

[add component documentation]

###### CAM2_XGM

Instance id: | MID_EXP_SAM/ZEROMQ/CAM2_XGM
Host: | exflonc26
Alias: | la2-br-kc-comp-2 , sa2-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-03-09T17:36:17.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.0.1-2.7.1
Deployment tag: | 3.0.1-2.7.1
Installed tag: | None
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Device is installed in development mode!

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘3.0.1-2.7.1’])!

[add instance documentation]

Release History
3.0.1-2.7.1

Created: | 2020-03-09T16:39:08.000Z
Author: | Thomas Michelat
Notes: | FIX for device crashing if a incoming data source name contains a dot.

3.0.0-2.7.1

Created: | 2020-02-17T18:11:31.000Z
Author: | Thomas Michelat
Notes: |

2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

##### MDL

[add component documentation]

###### LOHEX_REPEATER

Instance id: | MID_EXP_SAM/MDL/LOHEX_REPEATER
Class id: | GenericActuator
Host: | mid-rr-sys-con-10
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | MID_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### SSHEX_REPEATER

Instance id: | MID_EXP_SAM/MDL/SSHEX_REPEATER
Class id: | GenericActuator
Host: | mid-rr-sys-con-10
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | MID_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

##### DCTRL

[add component documentation]

###### CR1_COIL

Instance id: | MID_EXP_SAM/DCTRL/CR1_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### CR2_COIL

Instance id: | MID_EXP_SAM/DCTRL/CR2_COIL
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

[add component documentation]

###### PG1

Instance id: | MID_EXP_SAM/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_SAM/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_SAM/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TPUMP

[add component documentation]

###### TP1

Instance id: | MID_EXP_SAM/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP2

Instance id: | MID_EXP_SAM/TPUMP/TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

[add component documentation]

###### GV1

Instance id: | MID_EXP_SAM/VALVE/GV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV2

Instance id: | MID_EXP_SAM/VALVE/GV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVD

Instance id: | MID_EXP_SAM/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_EXP_SAM/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### VV1

Instance id: | MID_EXP_SAM/VALVE/VV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### VV2

Instance id: | MID_EXP_SAM/VALVE/VV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### VV3

Instance id: | MID_EXP_SAM/VALVE/VV3
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

#### SYS

##### TSYS

###### TIMESERVER

Instance id: | MID_EXP_SYS/TSYS/TIMESERVER
Class id: | TimeServer
Host: | mid-exp-sys-utc-2
Class documentation:
| TimeServer
Alias: | exflutc212-mch , exflqr30164-mch
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.0-2.10.0
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.8.0-2.10.0) does not match tags mentioned in the deployment ([‘2.8.1-2.11.1’])!

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: |

###### UTC-2-S4

Instance id: | MID_EXP_SYS/TSYS/UTC-2-S4
Class id: | X2Timer
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | agipd_overview, agipd_overview_old, Clock-and-Control, Clock-and-Control, agipd_overview, agipd_overview_oldold, agipd_overview, agipd_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- bunchPatternDelay:
    Delay of the bunch pattern as a whole. Only triggers using the bunch pattern will be affected.
- updateInterval:
    The interval for updating the x2Timer for read-out values.

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

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

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

###### TIMESERVER2

Instance id: | MID_EXP_SYS/TSYS/TIMESERVER2
Class id: | TimeServer
Host: | mid-exp-sys-utc-2
Class documentation:
| TimeServer
Alias: | exflutc212-mch , exflqr30164-mch
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.0-2.10.0
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.8.0-2.10.0) does not match tags mentioned in the deployment ([‘2.8.1-2.11.1’])!

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: |

#### TEST

##### MDL

###### SOUND_PLAYER

###### TARGET_A

#### UPP

##### CTRL

###### LSHORE

Instance id: | MID_EXP_UPP/CTRL/LSHORE
Class id: | LakeshoreModel336
Host: | mid-rr-sys-con-10
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lakeshoreHeaterPy
Last modified: | 2020-11-30T15:56:21.000+01:00
Created at: | 2017-01-06T14:10:51.000+01:00
Main authors: | Fabbri, Haufs, Parenti
Latest tag: | 1.2.4-2.10.0
Deployment tag: | 1.2.4-2.10.0
Scenes: | LSHORE, CRYOSTAT_LAKESHORE, LSHORE, Lakeshore, UserMain, UserSupportingScene, USER_SCENE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- propertiesToPoll:
    All specified properties will be polled from the instrument with the given poll-rate
- 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!
- connectDevice:
    Connects to the SCPI device
- disconnect:
    Disconnects from the device
- reset:
    Resets the device in case of an error
- alarmReset:
    Clears both the high and low status of all alarms, including latching alarms.

Release History
1.2.4-2.10.0

Created: | 2020-11-30T15:56:26.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.2.3-2.9.1

Created: | 2020-09-29T16:27:46.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update SCPI base class to tag 1.3.12-2.9.1

1.2.2-2.9.1

Created: | 2020-08-24T12:11:11.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update SCPI base class to tag 1.3.11-2.9.1

1.2.1-2.7.2

Created: | 2020-03-05T14:53:59.000+01:00
Author: | Andrea Parenti
Notes: | Update SCPI base device version

1.2.0-2.3.4

Created: | 2019-02-12T17:28:58.000+01:00
Author: | Andrea Parenti
Notes: | Add arbitrary name to input channels Add Alarms to Model 336

1.1.1-2.2.6

Created: | 2018-09-14T10:43:48.000+02:00
Author: | Andrea Parenti
Notes: | Add Inputs C and D to Model 336

1.1.0-2.2.3

Created: | 2018-05-14T08:46:39.000+02:00
Author: | Andrea Parenti
Notes: | Add support to Model 325

1.0.0-2.2.3

Created: | 2017-01-17T10:09:10.000+01:00
Author: | Andrea Parenti
Notes: |

##### DCTRL

###### PG1

Instance id: | MID_EXP_UPP/DCTRL/PG1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_UPP/DCTRL/PG2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_UPP/DCTRL/PG3
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_UPP/DCTRL/PG4
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_UPP/DCTRL/SPARE_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_UPP/DCTRL/SPARE_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### GAUGE

###### PG1

Instance id: | MID_EXP_UPP/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG2

Instance id: | MID_EXP_UPP/GAUGE/PG2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG3

Instance id: | MID_EXP_UPP/GAUGE/PG3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PG4

Instance id: | MID_EXP_UPP/GAUGE/PG4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_A2

Instance id: | MID_EXP_UPP/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### SPARE_B2

Instance id: | MID_EXP_UPP/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### R1

###### R2

###### R3

###### R4

###### R5

###### R6

###### R7

###### R8

###### T1

###### T10

###### T11

###### T12

###### T13

Instance id: | MID_EXP_UPP/MOTOR/T13
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, UPP_slits_test0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T14

Instance id: | MID_EXP_UPP/MOTOR/T14
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | MID_EXP_SAM-allMotors, MID_EXP_SAM-allMotors, UPP_slits, UPP_slits_test0, UPP_slits_test0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T15

Instance id: | MID_EXP_UPP/MOTOR/T15
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | UPP_slits, UPP_slits_test0, UPP_slits_test0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T16

Instance id: | MID_EXP_UPP/MOTOR/T16
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | UPP_slits, UPP_slits_test0, UPP_slits_test0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T2

###### T3

Instance id: | MID_EXP_UPP/MOTOR/T3
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### T4

###### T5

###### T6

###### T7

###### T8

###### T9

##### TPUMP

###### TP1

Instance id: | MID_EXP_UPP/TPUMP/TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### TP2

Instance id: | MID_EXP_UPP/TPUMP/TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

##### TSENS

###### PT1

Instance id: | MID_EXP_UPP/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | SOLN_1_U0, SOLN_1, PeltierCooler, TEST, PeltierCooler20200, SOLN_1_real
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### PT2

Instance id: | MID_EXP_UPP/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | SOLN_1_U0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### VALVE

###### GVD

Instance id: | MID_EXP_UPP/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GVU

Instance id: | MID_EXP_UPP/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TCTRL

[add component documentation]

###### LINKAM

##### ENC

[add component documentation]

###### T3

Instance id: | MID_EXP_UPP/ENC/T3
Class id: | BeckhoffEncoder
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### TSYS

[add component documentation]

###### TRIGGER_CAM1

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM3

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_CAM3
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_TTL_IN_1

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_TTL_IN_1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_TTL_IN_2

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_TTL_IN_2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### TRIGGER_TTL_IN_3

Instance id: | MID_EXP_UPP/TSYS/TRIGGER_TTL_IN_3
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### VAC

##### GAUGE

###### PG_RESERVE1

Instance id: | MID_EXP_VAC/GAUGE/PG_RESERVE1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | EXP_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ICTRL

###### IPCTRL

Instance id: | MID_EXP_VAC/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### VS_GROUP

Instance id: | MID_EXP_VAC/MDL/VS_GROUP
Class id: | VacuumSectionGroup
Host: | exflcon138
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/vacuumSection
Last modified: | 2020-11-24T12:51:45.000+01:00
Created at: | 2016-11-16T14:10:37.000+01:00
Main authors: | Haufs, Schaffer, Ehsan
Latest tag: | 2.1.8-2.10.0
Deployment tag: | 2.1.8-2.10.0
Scenes: | EXP_main_Vacuum_scene, EXP_main_Vacuum_scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- poll_policy:
    Poll policy of ion-pump and gauge device properties
- reset_vacuum_sections:
    Resets vacuum section devices in ERROR and requests their h/w values from PLC

Release History
2.1.8-2.10.0

Created: | 2020-11-24T11:51:57.000Z
Author: | Wajid Ehsan
Notes: | Update Version Info

2.1.7-2.5.0

Created: | 2019-07-16T15:12:15.000Z
Author: | Christopher Youngman
Notes: | added turbo pumps device and table

2.1.6-2.4.0

Created: | 2019-07-03T10:26:24.000Z
Author: | Christopher Youngman
Notes: | Adds INITONLY settable time between requests property and some bookkeeping with it to avoid/see KaraboError occurances.

2.1.5-2.4.0

Created: | 2019-07-02T13:07:15.000Z
Author: | Christopher Youngman
Notes: | Catches KaraboError exception and continues if VacuumSection ‘reset’ and ‘request_hw_values’ slot calls throw the exception.

2.1.4-2.4.0

Created: | 2019-05-27T09:07:24.000Z
Author: | Christopher Youngman
Notes: | Adds additional MDL device above the VacuumSection called VacuumSectionGroup, whose table element lists VacuumSetction to receive ‘Reset’ followed by ‘Request h/w values’ when ‘Force Refresh’ is fired.

2.1.3-2.4.0

Created: | 2019-05-09T13:53:20.000Z
Author: | Robert Schaffer
Notes: | Added units to the agilent ion-pump properties

2.1.2-2.3.2

Created: | 2019-01-11T15:12:52.000Z
Author: | Robert Schaffer
Notes: | Added a workaround for the table-element bug, which is to be addressed in karabo-2.3.3. Also improved error handling for this table element (may be also handled by the bugfix).

2.1.1-2.2.5

Created: | 2018-10-15T12:01:43.000Z
Author: | Valerii Bondar
Notes: | Version with scene generation. Was successfully tested in tunnel.

2.1.0-2.2.4

Created: | 2018-03-27T12:08:25.000Z
Author: | Dennis Goeries
Notes: | Device Scene added

2.0.5-2.2.1

Created: | 2018-02-16T09:55:20.000Z
Author: | Christopher Youngman
Notes: | Remove superfluous state set

2.0.4-2.2.1

Created: | 2018-02-05T14:42:06.000Z
Author: | Christopher Youngman
Notes: | Exposes aggregated ion-pump and guage alarm and state as those of the VS device

2.0.3-2.1

Created: | 2017-06-20T07:51:51.000Z
Author: | Dennis Goeries
Notes: |

2.0

Created: | 2016-12-12T18:08:12.000Z
Author: | Alessandro Silenzi
Notes: | running version with karabo 2.0. This is tagged for old compatiblity since a new version is coming up.

2.0.2-1.4

Created: | 2016-11-30T09:02:37.000Z
Author: | Wajid Ehsan
Notes: | version 1.4

0.1.0-1.4

Created: | 2016-11-04T15:04:02.000Z
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/0.1.0-1.4” via karabo script

tags

Created: | 2016-11-04T14:17:55.000Z
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/tags/0.1.0-1.4” via karabo script

##### TPUMP

###### TP_RESERVE1

Instance id: | MID_EXP_VAC/TPUMP/TP_RESERVE1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

###### GV_RESERVE1

Instance id: | MID_EXP_VAC/VALVE/GV_RESERVE1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### GV_RESERVE2

Instance id: | MID_EXP_VAC/VALVE/GV_RESERVE2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### VS

###### VS_ALAS

###### VS_AUXT3

###### VS_DES

###### VS_DPS

###### VS_MIRR

###### VS_ROUGH

#### JNGFR01

##### TSYS

###### CONTROL

Instance id: | MID_EXP_JNGFR01/TSYS/CONTROL
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### JNGFR02

##### TSYS

###### CONTROL

Instance id: | MID_EXP_JNGFR02/TSYS/CONTROL
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### JF500K1

[add component documentation]

##### DET

[add component documentation]

###### CONTROL

Instance id: | MID_EXP_JF500K1/DET/CONTROL
Host: | exflcon187
Class documentation:
| JungfrauControl
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-04-30T14:33:02.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.2-2.8.3
Deployment tag: | 1.7.2-2.8.3
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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_:

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

- 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

- 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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    First storage cell to be used. For very advanced users only!

- rxUdpSocketSize:

    For very advanced users only!

Release History
1.7.2-2.8.3

Created: | 2020-04-30T12:40:13.000Z
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T05:03:42.000Z
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T09:29:59.000Z
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

##### CAL

[add component documentation]

###### MANAGER

Instance id: | MID_EXP_JF500K1/CAL/MANAGER
Class id: | CalManager
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/karaboDevices/calPy
Last modified: | 2021-09-30T14:30:36.393+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.2.1-2.10.0-test3
Deployment tag: | 2.2.1-2.10.0-test3
Installed tag: | 2.2.0-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.2.0-2.10.0) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

#### JF500K2

[add component documentation]

##### CAL

[add component documentation]

###### CORR_GAIN

Instance id: | MID_EXP_JF500K2/CAL/CORR_GAIN
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-06-29T17:47:14.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Karnevskiy, Karnem
Latest tag: | 1.15.1-2.9.1
Deployment tag: | 1.15.1-2.9.1
Scenes: | JF02, MID_EXP_JF500K2-CAL, JF02_CONTROL
Accessible by: | CAL, CONTROLS, DA, amunnich, danilevc, jsztuk

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    First storage cell to be used. For very advanced users only!

- rxUdpSocketSize:

    For very advanced users only!

Release History
1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET

Instance id: | MID_EXP_JF500K2/CAL/CORR_OFFSET
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-06-29T17:47:14.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Karnevskiy, Karnem
Latest tag: | 1.15.1-2.9.1
Deployment tag: | 1.15.1-2.9.1
Scenes: | JF02, MID_EXP_JF500K2-CAL, JF02_CONTROL
Accessible by: | CAL, CONTROLS, DA, amunnich, danilevc, jsztuk

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    First storage cell to be used. For very advanced users only!

- rxUdpSocketSize:

    For very advanced users only!

Release History
1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

###### DARK_CHAR

Instance id: | MID_EXP_JF500K2/CAL/DARK_CHAR
Host: | exflcon187
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2020-06-18T16:09:50.000+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Hauf, Ehsan, Ahmed
Latest tag: | 1.2.0-2.8.0-test
Deployment tag: | 1.2.0-2.8.0-test
Scenes: | JF02_CONTROL
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

- 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

- 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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number of trains (or soft triggers)

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    Starting storage cell for burst mode acquisitions.

- rxUdpSocketSize:

    For very advanced users only!

- useBurstMode:

    Check if testing for burst-mode configuration

Release History
1.2.0-2.8.0-test

Created: | 2020-04-14T08:50:05.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T15:52:43.000Z
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T08:18:27.000Z
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T13:26:07.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T13:27:35.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T13:22:50.000Z
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T15:02:41.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T08:53:07.000Z
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T08:29:22.000Z
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T13:26:52.000Z
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T09:43:32.000Z
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T08:33:46.000Z
Author: | Steffen Hauf
Notes: |

###### MANAGER

Instance id: | MID_EXP_JF500K2/CAL/MANAGER
Class id: | CalManager
Host: | exflong15
Alias: | mid-br-sys-cal-13
Git repo: | https://git.xfel.eu/karaboDevices/calPy
Last modified: | 2021-09-30T14:30:36.393+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.2.1-2.10.0-test3
Deployment tag: | 2.2.1-2.10.0-test3
Installed tag: | 2.2.0-2.10.0
Scenes: | JF02, MID_EXP_JF500K2-CAL, JF02_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.2.0-2.10.0) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

##### DET

[add component documentation]

###### CONFIG

Instance id: | MID_EXP_JF500K2/DET/CONFIG
Host: | exflcon187
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2020-06-18T16:09:50.000+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Hauf, Ehsan, Ahmed
Latest tag: | 1.2.0-2.8.0-test
Deployment tag: | 1.2.0-2.8.0-test
Scenes: | JF02_CONTROL
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

- 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

- 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:
    In case of an Error, allow for taking

      different actions through an ACTIVE state

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number of trains (or soft triggers)

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    Starting storage cell for burst mode acquisitions.

- rxUdpSocketSize:

    For very advanced users only!

- useBurstMode:

    Check if testing for burst-mode configuration

- configMan:

    Configure the calibration manager

- toggleDAQ:

    Automatically toggling the DAQ to connect to the receivers.

- burstMode:

    Switching to Burst Mode

- singleCell:

    Switching to Single Cell

Release History
1.2.0-2.8.0-test

Created: | 2020-04-14T08:50:05.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T15:52:43.000Z
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T08:18:27.000Z
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T13:26:07.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T13:27:35.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T13:22:50.000Z
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T15:02:41.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T08:53:07.000Z
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T08:29:22.000Z
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T13:26:52.000Z
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T09:43:32.000Z
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T08:33:46.000Z
Author: | Steffen Hauf
Notes: |

###### CONTROL

Instance id: | MID_EXP_JF500K2/DET/CONTROL
Host: | exflcon187
Class documentation:
| JungfrauControl
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-04-30T14:33:02.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.2-2.8.3
Deployment tag: | 1.7.2-2.8.3
Scenes: | JF02, JF02_CONTROL
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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_:

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

- 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

- 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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    First storage cell to be used. For very advanced users only!

- rxUdpSocketSize:

    For very advanced users only!

- useBurstMode:

    Check if testing for burst-mode configuration

- configMan:

    Configure the calibration manager

- toggleDAQ:

    Automatically toggling the DAQ to connect to the receivers.

- burstMode:

    Switching to Burst Mode

- singleCell:

    Switching to Single Cell

Release History
1.7.2-2.8.3

Created: | 2020-04-30T12:40:13.000Z
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T05:03:42.000Z
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T09:29:59.000Z
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

###### JNGFR02

Instance id: | MID_EXP_JF500K2/DET/JNGFR02
Host: | exflcon187
Class documentation:
| JungfrauReceiver
Alias: | mid-rr-sys-con-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-04-30T14:33:02.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.2-2.8.3
Deployment tag: | 1.7.2-2.8.3
Scenes: | JF02, JF02_CONTROL
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

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_:

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

- 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

- 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 device in case of an error

- 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

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrate:

    Calibrate actual position to calibrated position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    Move command.

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- actualPosition:

    Actual position used for scanning.

- stepSize:

    Step size for up and down button

- targetVelocity:

    AMoveVelocity

- targetPosition:

    Target position used for scanning.

- 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.

- mc2DiscreteMotion:

    e.g. relative or absolute position movement

- mc2ContinuousMotion:

    e.g. constant velocity

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    Increase delay by one step.

- stepDown:

    Decrease delay by one step.

- activeController:

    Select the Active Controller.

- activeControllerPLC:

    Select the Active Controller.

- timeServerId:

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

- 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

- ignore:

    Ignore

- configure:

    Load pattern and bunch structure files to detector.

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- 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

- 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:

    The deviceId of the RunController to use, starts and stops daq.

- 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.

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- group:

    Group of nodes to look for tags

- owner:

    The person to contact regarding usage of this group

- 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

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- channels:

    Container populated with channels discovered in the crate.

- fastSources:

    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.

- slowSources:

    Device properties to monitor

- output:

    Output channel for combined data

- sent:

    Count how many train data were sent.

- buffer:

    Length of buffer to hold non-complete trains in.

- propertyUpdateInterval:

    Set time inteval between property updates

- input:

    Input channel for data from dispatchers

- outputsConfig:

    Configuration for ZeroMQ sockets

- pollTimeout:

    ZMQ poller timeout in milliseconds.

- filters:

    Configuration options for input data filtering.

- inputUpdated:

    Count input channel calls.

- dataRecv:

    How many datas are received on input channel call.

- onInputTotal:

- addressOutput0:

    Address to use to get data from this output

- data_sent0:

    Count total of train data sent on this output

- onSetpoint:

    Boolean indicating if the pump has reached the setpoint.

- isSwitchedOn:

    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.

- slimInterface:

    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.

- pressure:

    Pressure read out from analog input. NOT available in slim mode.

- voltage:

    Voltage read out from analog input. NOT available in slim mode.

- hvOn:

    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- hvOff:

    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.

- channelSelection:

    Channel on the controller for the pump.

- highVoltageOn:

    Turn on high voltage of the selected channel; this is a serial Property

- pressureSerial:

    Presssure of the selected channel; this is a serial readout.

- deviceInSlot:

    Device in the selected channel; this is a serial Property

- maximumPower:

    Maximum power for the selected channel; this is a serial Property

- targetVoltage:

    Target Voltage for the selected channel; this is a serial Property

- protectCurrent:

    Protect current for the selected channel; this is a serial Property

- setPoint:

    Setpoint for the selected channel; this is a serial Property

- temperatureHV:

    Temperature for HV end for the selected channel; this is a serial Property

- voltageSerial:

    Voltage for the selected channel; this is a serial Property

- highVoltageOn1:

    Turn on high voltage of channel 1.

- highVoltageOn2:

    Turn on high voltage of channel 2.

- highVoltageOn3:

    Turn on high voltage of channel 3.

- highVoltageOn4:

    Turn on high voltage of channel 4.

- pressureCh1:

    Pressure for channel 1. This is a serial readout.

- pressureCh2:

    Pressure for channel 2. This is a serial readout.

- pressureCh3:

    Pressure for channel 3. This is a serial readout.

- pressureCh4:

    Pressure for channel 4. This is a serial readout.

- deviceInSlot1:

    Device in slot 1.

- deviceInSlot2:

    Device in slot 2.

- deviceInSlot3:

    Device in slot 3.

- deviceInSlot4:

    Device in slot 4.

- maximumPower1:

    Maximum power for channel 1

- maximumPower2:

    Maximum power for Channel 2

- maximumPower3:

    Maximum power for Channel 3

- maximumPower4:

    Maximum power for Channel 4

- targetVoltage1:

    Target Voltage Channel 1

- targetVoltage2:

    Target voltage for channel 2

- targetVoltage3:

    Target voltage for channel 3

- targetVoltage4:

    Target voltage for channel 4.

- protectCurrent1:

    Protect current for channel 1.

- protectCurrent2:

    Protect current for channel 2.

- protectCurrent3:

    Protect current for channel 3.

- protectCurrent4:

    Protect current for channel 4.

- setPoint1:

    Setpoint for channel 1.

- setPoint2:

    Setpoint for channel 2.

- setPoint3:

    Set Point for channel 3.

- setPoint4:

    Setpoint for channel 4.

- temperatureHV1:

    Temperature HV for channel 1.

- temperatureHV2:

    Temperature HV for channel 2.

- temperatureHV3:

    Temperature HV for channel 3.

- temperatureHV4:

    Temperature HV for channel 4.

- voltageCh1:

    Voltage for channel 1.

- voltageCh2:

    Voltage for channel 2.

- voltageCh3:

    Voltage for channel 3.

- voltageCh4:

    Voltage for channel 4.

- currentSerial:

    Current for the selected channel.

- currentCh1:

    Current for channel 1.

- currentCh2:

    Current for channel 2.

- currentCh3:

    Current for channel 3.

- currentCh4:

    Current for channel 4.

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- 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.

- isOpened:

    Status limit switch opened.

- isClosed:

    Status limit switch closed.

- open:

    Instructs device to open

- close:

    Instructs device to close

- maxSwTime:

- invertValue:

    1=invert coil logic

- invertLimits:

    0=Limits active high 1=limits active low

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- temperature:

    Camera temperature. Not available for all models.

- useAsBackgroundImage:

    Use the current image as background image.

- 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.

- x2Timer:

    Device ID of X2Timer

- channelName:

    Input (e.g. frontTrg1 or rtmTrg9)

- condTriggerOn:

    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.

- condTriggerOff:

    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.

- condTriggerMask:

    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.

- useCondTrigger:

    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.

- invertTrigger:

    Invert the trigger signal.

- setControl:

    Set the control value

- actualDelay:

    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.

- targetDelay:

    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.

- setDelay:

    Set the delay in nano sec.

- targetDuration:

    The target duration. Press ‘Set Duration’ to apply this value.

- setDuration:

    Set the duration.

- maxTrainFreq:

    Maximum bunch train frequency with current trigger duration.

- targetPulseEvent:

    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.

- setPulseEvent:

    Set the macro P-Event.

- targetPicoDelay:

    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.

- setPicoDelay:

    Set the pico delay.

- targetInhibit:

    The target inhibit. Press ‘Set Inhibit’ to apply this value.

- setInhibit:

    Set the inhibit.

- usePicoDelay:

    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.

- stepMult2:

    Multiply the step size by 2.

- stepDiv2:

    Divide the step size by 2.

- scale:

    Scaling factor for analog value.

- offset:

    Calibration Offset

- rawValue:

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

- enablePumpingStation:

    Enables the pumping station (does not start pumping yet)

- disablePumpingStation:

    Disables the pumping station

- startPumping:

    Starts the pump

- stopPumping:

    Stops the pump

- startStandby:

    Start Standby operation

- stopStandby:

    Stop Standby operation

- remotePriorityOn:

    Enable remote control

- remotePriorityOff:

    Disable remote control

- startHeating:

    Start Heating

- stopHeating:

    Stop Heating

- resetController:

    reset error on controller

- startVenting:

    Start Venting

- stopVenting:

    Stop Venting

- enableRtsCts:

    Enable RTS/CTS

- enableXonXoffTx:

    Enable XOn/XOff supported tx data

- enableXonXoffRx:

    Enable XOn/XOff supported rx data

- enableFifoCont:

    Enable send FIFO data continuous

- enableTransferOpt:

    Enable transfer rate optimization

- baudRate:

    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.

- dataFrame:

    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.

- bufferFull:

    Buffer Full Notification.

- serialString:

    Send serial string.

- serialCheck:

    Check serial protocol command value (reads back string from command function window (ASerP input value)

- heatingOnOff:

    Heating On/Off.

- standbyOnOff:

    Standby On/Off.

- pumpingStationOnOff:

    Pumping station On/Off.

- enableVenting:

    Enable venting.

- remotePriority:

    Remote priority.

- isRPMExceed:

    isRPMExceed

- runUpTimeOnOff:

    Run-up time control

- errorAck:

    Error Acknowledgment.

- rotationSpeedSwitchpoint:

    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.

- configDO2:

    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- motorPump:

    Motor pump.

- configDO1:

    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station

- backingPump:

    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on

- rotationSpeedSettingMode:

    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.

- gasMode:

    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.

- ventingMode:

    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.

- accessoryConnectionA1:

    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB1:

    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionA2:

    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- accessoryConnectionB2:

    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.

- sealingGasOnOff:

    Sealing gas On/Off.

- configOutputA01:

    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.

- controlInterface:

    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.

- interfaceSelectionLocked:

    Lock interface selection.

- configInputDI1:

    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- configInputDI2:

    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.

- rotationSpeedSwitchPointAttained:

    Rotation speed switch point attained.

- errorCode:

    Error code.

- overtTempDriveUnit:

    Over temperature drive unit.

- overtTempPump:

    Over temperature pump.

- setSpeedAttained:

    Set speed attained.

- pumpAccelerates:

    Pump accelerates.

- setRotationSpeed:

    Set rotation speed.

- actualRotationSpeed:

    Actual rotation speed.

- driveCurrent:

    Drive current.

- operatingHoursPump:

    Operating hours pump.

- firmwareVersion:

    Firmware version drive unit.

- driveVoltage:

    Drive voltage.

- operatingHoursDriveUnit:

    Operating hours drive unit.

- nominalRotationSpeed:

    Nominal rotation speed.

- drivePower:

    Drive power.

- pumpCycles:

    Pump cycles.

- temperatureElectronic:

    Temperature electronics.

- temperaturePumpBottom:

    Temperature pump bottom part.

- acceleration:

    Acceleration [rpm/s].

- temperatureBearing:

    Temperature bearing.

- temperatureMotor:

    Temperature motor.

- driveUnitName:

    Name of the electronic drive unit.

- hwVersionDriveUnit:

    Hardware version of electronic drive unit.

- errorCodeHistory1:

    Error code history 1.

- errorCodeHistory2:

    Error code history 2.

- errorCodeHistory3:

    Error code history 3.

- errorCodeHistory4:

    Error code history 4.

- errorCodeHistory5:

    Error code history 5.

- errorCodeHistory6:

    Error code history 6.

- errorCodeHistory7:

    Error code history 7.

- errorCodeHistory8:

    Error code history 8.

- errorCodeHistory9:

    Error code history 9.

- errorCodeHistory10:

    Error code history 10.

- setRotationSpeedRpm:

    Set rotation speed [rpm].

- actualRotationSpeedRpm:

    Actual rotation speed [rpm].

- nominalRotationSpeedRpm:

    Nominal rotation speed [rpm].

- targetRunupTime:

    The run-up time set value.

- rotationSpeedSwitchpoint1:

    The rotation speed switch point 1.

- rotationSpeedSettingModeValue:

    The value of the rotation speed setting mode.

- powerConsumptionValue:

    The value of power consumption.

- switchOffThresholedBKP:

    Switching off threshold backing pump in intermittent mode.

- switchOnThresholedBKP:

    Switching on threshold backing pump in intermittent mode.

- rotationSpeedStandBy:

    The rotation speed at stand-by.

- rotationSpeedSwitchpoint2:

    The rotation speed switch point 2.

- rotationSpeedDelayedVenting:

    The venting rotation speed at delayed venting.

- ventingTimeDelayedVenting:

    The venting time at delayed venting.

- nominalRotationSpeedConfirmation:

    Confirmation of nominal rotation speed.

- rs485DeviceAddress:

    The address of the RS485 device.

- 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

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- inputs:

    Input for split data

- filteredOutput:

    Output channel for combined data, filtered to a single image

- indexToFilter:

    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4

- bufferLength:

    Length of buffer to hold non-complete trains in

- calibration_hash_schema_version:

    Version of the Hash Schema Definition

- device_name:

    Should be of form INSTANCE.MODULE

- caldb_zmq_timeout:

    Timeout for ZMQ request

- eosCallback:

    Optionally call this function on an EOS event.

- isEntryPoint:

    Device is entry point to a pipeline. Stalls will occur here if iteration happens

- active:

    If set to False data is simply passed on

- dontProcess:

    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

- generateTestData:

    Generate test data based on last input real data

- gpuFreeLimit:

    Temporarily stall the pipeline, and free GPU resources if below this limit

- replay_delay:

    Delay in seconds between each train data

- start_pipline:

  > Start the calibration pipeline.

  > This should be executed with all servers in a clean state!

- execute:

    Set all the values with the proper tag in the devices

- pciedev:

    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5

- mapdir:

    The filesystem directory with XML files assigning logical names to internal locations in device space

- sdelay:

    Delay between consecutive settings

- project_version:

    Version of implemented project

- project_date:

    Date of the last change of the project.

- project_user:

    User defined register for free use within software to store and read back project related information.

- firmware_ready:

    Firmware status

- fem_status:

    FEM Status: (1) - OK (0) - not OK

- onboard_clock:

    On-board Clock: (1) - Present (0) - Absent

- tr_clock:

    Timing Receiver Clock: (1) - Present (0) - Absent

- fem_clock:

    FEM Clock: (1) - Present (0) - Absent

- timing_synch:

    When 1 - C&C synch with Timing information

- ccStandardOperation:

    Switch to standard (normal) operation.

- softReset:

    Reset clock.

- train_id:

    Current Timing Receiver Train ID (64 bits)

- train_id_mismatch:

    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID

- pll_ratio:

    Current PLL clock multiplier

- cc_slave:

    C&C board mode: Slave or Master

- cc_standalone:

    When 1 - C&C in standalone mode

- cc_trigger_mode:

    C&C Trigger mode: “Internal” or “Timing board”

- trigger_test_mode:

    Trigger simulation mode: “Continuous” or “Single”

- trigger_delay:

    Number clock cycles to delay the trigger start signal.

- trigger_period:

    Continuous trigger period

- stop_trigger_limit:

    Time between START and STOP command in 99 MHz clock cycles

- train_id_test:

    Initial train ID for standalone mode

- train_id_update:

    Writing 1 will update Train ID test

- pattern_index_test:

    Initial bunch pattern index for standalone mode.

- pattern_index_update:

    Writing 1 will update Pattern Index test

- ccTriggerStart:

    Trigger simulation start.

- ccTriggerStop:

    Trigger simulation stop.

- fast_data:

    When true - enable FAST data

- fast_custom_message:

    When 1 - send a fixed payload on the FAST line.

- fast_custom_command:

    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- chillerTypeString:
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- filterTime:
    Filter Timer for error signals
- 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.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- 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).
- 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].
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- 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.
- devices:
    Devices to act upon
- tags:
    The list of tags to be enabled or disabled
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- aggregate_state:
    The most significant state of all dependent devices
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- voltageRiseRate:
    The rate assigned for voltage ramp up in V/sec on the channel.
- voltageFallRate:
    The rate assigned for voltage ramp down in V/sec on the channel
- userConfig:
    Bit 0: Voltage ramping at switch off:

0: Ramp down at switch off. 1: No ramp at switch off (immediate off)

Bit 1, 2: Set different regulation modes, dependent on the cable inductance: 0: short cables, up to 1 meter. 1: cables from 1 to 30 meter. 2: cables longer than 30 meter. 3: slow (identical to 2, should not be used)

Bit 3: Internal sense line connection to the output (MPOD only): 0: The sense input at the sense connector is used for regulation. 1: The output voltage is used for regulation. Any signals at the sense connector are ignored.

Bit 4: External Inhibit input. 0: The external inhibit input is ignored. 1: The external inhibit input must be connected to a voltage source to allow switch on.

- loadChannelConfigs:

    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.

- startupConfigType:

    Defines whether last saved or approved configuration is loaded on instantiation

- applyInProgress:

    Load configs in progress if True

- loadedChannelConfigFile:

    Last loaded channel config filename

- appliedChannelConfigType:

    Last applied channel config filename

- slotSaveConfiguration:

    Write the current configuration to store

- slotApplyConfiguration:

    Applies last saved configuration from store to h/w and s/w

- slotApplyApprovedConfiguration:

    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup

- hostname:

    Host name or IP address for communication module in MPOD crate

- type:

    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests

- updatePolicy:

    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll

- configuration:

    Container for configuration properties

- setCmdErrors:

    Count of snmp set command errors

- setCmdFailed:

    Count of snmp set command failures

- getCmdErrors:

    Count of snmp get command errors

- walkCmdErrors:

    Count of snmp walk command errors

- pollResultSkips:

    Count of poll result set skipped due to concurrent command received

- pollSetCount:

    Count of sets in single hash sent to control system at end of last poll

- slotEnable:

    When enabled crate output channels can be switched on/off

- slotDisable:

    When disabled crate output channels cannot be switched on

- slotReset:

    Reset device

- slotClearInterlocks:

    Clear all latched interlocks

- autoRearm:

    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll

- slotClearTrips:

    Clear all trips

- slotInjectError:

    Force to ERROR

- pollTimeTaken:

    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time

- pollCount:

    Poll counter, resets to zero on Enable

- pollChannelSummary:

    Last poll channel status

- boards:

    The node represents all MPOD boards

- invert:

    If set, the digital value as received from the hardware is inverted.

- edgeCount:

    Counter of the input edges

- resetCounter:

    Reset count of edges

- fallingEdgeCounter:

    True - Counter On Falling Edge; False - Counter on Raising Edge.

- tineHome:

    The TINE_HOME to be used by the device

- address:

    A string of the form ‘/context/server/device’, eg /TEST/WinSineServer/SineGen0

- startMc:

    Start the micro-controller.

- startMasterFpga:

    Start the master FPGA.

- startAuxAndAnalogVolt:

    Start AUX and the analog voltage.

- startVacAndAnalogCards:

    Start vacuum and analog cards.

- startModuleFpga:

    Start the module FPGA.

- startAsics:

    Start the ASICS.

- startAutoPowerUp:

    Start the automatic power-up.

- port:

    The port for TCP/IP communication with the FPGA.

- bootId:

    The boot slot ID. Setting it will reboot the FPGA.

- initAsics:

    Initialize the ASICs. The procedure will last a few seconds.

- loadPattern:

    Load pattern file to detector.

- loadBunch:

    Load bunch structure file to detector.

- asicInitFile:

    Use ‘initAsics’ command to load.

- patternFile:

    Use ‘loadPattern’ or ‘configure’ command to load.

- bunchFile:

    Use ‘loadBunch’ or ‘configure’ command to load.

- mask:

    This parameter will be applied upon connection.

- sleepTime:

    Sleep time after pattern and bunch structure setting.

- temp_goal_heat:

    Temperature setpoint to heat up to.

- temp_goal_cool:

    Temperature setpoint to cool down to.

- ramp_time_offset:

    Offset in addition to the calulated ramping time to wait until ramping is expected to have finished

- t_limit_vac_needed:

    Temperature below which pressure is checked

- cool:

  > Starts the cool procedure to cool down the system.

  > Checks are carried out if conditions are met. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- heat:

  > Starts the heating procedure to heat up the system.

  > Checks are carried out if relevant hardware is ok. In the case of failures Alarms will be triggered and the device will go into the UNKNOWN state.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- acquisitionTime:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- nPulses:

    Number of pulses. It must be <= the number of memory cells configured in the pattern.

- sleepTimeAgipdComposite:

    Sleep time AgipdComposite to allow state change.

- enableByTag:

    Enable devices by tag.

- disableByTag:

    Disable devices by tag.

- mcState:

    The combined state of Microcontrollers

- masterState:

    The combined state master FPGAs

- fpgaState:

    The combined state of Read-Out FPGAs

- pcRowNr:

    Pulse Capacitor row number. You have to press ‘configure’ to apply.

- patternType:

    Use ‘configure’ command to load patterns.

- patternTypeIndex:

    This property is currently needed, as the DAQ does not store strings.

- egsgat:

    For display purposes only. It will be changed by applying the configuration.

- g1sgat:

    For display purposes only. It will be changed by applying the configuration.

- g2sgat:

    For display purposes only. It will be changed by applying the configuration.

- ticolm:

    For display purposes only. It will be changed by applying the configuration.

- setupr:

    For display purposes only. It will be changed by applying the configuration.

- vrfcds:

    For display purposes only. It will be changed by applying the configuration.

- bunchStructure:

    Bunch structure settings. Use ‘configure’ command to load them.

- configPath:

    Path to the configuration files.

- patternBaseName:

    Pattern base name, e.g. ‘pattern_template’.Use ‘configure’ command to load configuration;depending on the patternType it will load config_path/pattern_template_xray.txt orconfig_path/pattern_template_pc.txt

- gainFileName:

    Gain file name, e.g. ‘gain_settings.yml’.Use ‘configure’ command to load settings.

- loadYamlFile:

  > Load and parse the yaml file defining the power sequence(s)

- haltSequence:

    Halts the sequence. The current step will complete.

- continueSequence:

    Continue sequence on next step

- forceContinueSequence:

    Force to continue sequence on next step withoutretrying last step.

- retryLastStep:

    Retries the last step

- simulationMode:

    Set to true to step through sequences without actually configuring MPOD

- checkInterval:

    Interval in seconds with which thepower status of the detector is checked.

- slotRefresh:

    Refresh file information

- root:

    Defines the directory within the device’s working directory, in and below which all file manipulation is performed

- targetDevice:

    The deviceId of the configuration file

- lastSaved:

    Last saved file. The saved file is updated by this application OR mpod.py. The mpod.py update happens when its save configuration button is clicked.

- lastApproved:

    Approved file. The Approved file is not updated automatically by mpod.py and can changed only by this application

- typeFiles:

    List of all saved files. Cut and paste file names from this list into ‘New saved’ when defining a new saved file to be loaded.

- nextSaved:

    File to use to replace current saved file. Cut file name from ‘All saved files’ and paste here.

- slotDefineSaved:

    Sets link to file defined in ‘New saved file’ property above

- nextApproved:

    File name to use to replace current known Approved file cut file name from ‘All saved files’ and paste

- slotDefineApproved:

    Sets link to file defined in ‘New Approved file’ property above

- crateNode:

    Container for crate properties

- detectorHostName:

    Detector Host Name

- detectorIp:

    Detector IP. Must be on the same subnet as the receiver.

- detectorHostPort:

    Detector Host Port. Will use 1952 if left empty.

- detectorHostStopPort:

    Detector Host Stop Port. Will use 1953 if left empty.

- rxHostname:

    Receiver Hostname

- rxTcpPort:

    Receiver TCP Port

- rxUdpIp:

    Receiver UDP IP

- rxUdpPort:

    Receiver UDP Port

- settings:

    Settings

- online:

    Sets the detector in online (1) or offline (0) mode.

- angDir:

    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).

- moveFlag:

    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)

- lock:

    lock

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- framesPerTrain:

    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.

- frameRateIn:

    Frame rate - incoming data from detector.

- onlineDisplayEnable:

    Enable online display of detector data.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- storageCells:

    Number of additional storage cells. For very advanced users only!

- storageCellStart:

    First storage cell used by the Jungfrau. It is usually 15.

- rxUdpSocketSize:

    For very advanced users only!

- useBurstMode:

    Check if testing for burst-mode configuration

- configMan:

    Configure the calibration manager

- toggleDAQ:

    Automatically toggling the DAQ to connect to the receivers.

- burstMode:

    The Jungfrau is operated in “burst mode”, namely with external trigger and more than one memory cell.

- singleCell:

    Switching to Single Cell

Release History
1.7.2-2.8.3

Created: | 2020-04-30T12:40:13.000Z
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T05:03:42.000Z
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T09:29:59.000Z
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

#### PI

[add component documentation]

##### TCTRL

[add component documentation]

###### TED_EPIX2

### LAS

#### COM

##### ACTRL

###### IO3

Instance id: | MID_LAS_COM/ACTRL/IO3
Class id: | BeckhoffAnalogOutput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### ASENS

###### HUM_HYG

Instance id: | MID_LAS_COM/ASENS/HUM_HYG
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### HUM_TEMP

Instance id: | MID_LAS_COM/ASENS/HUM_TEMP
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### IO1

Instance id: | MID_LAS_COM/ASENS/IO1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### IO2

Instance id: | MID_LAS_COM/ASENS/IO2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### MOTOR

###### ATT1

###### ATT2

###### MIRR1_1

###### MIRR1_2

###### MIRR2_1

###### MIRR2_2

###### MIRR3_1

###### MIRR3_2

###### MIRR4_1

###### MIRR4_2

###### TLS1

###### TLS2

###### DL1030

Instance id: | MID_LAS_COM/MOTOR/DL1030
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### DL800

Instance id: | MID_LAS_COM/MOTOR/DL800
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Scenes: | PPScan, Macro_EXP_PPL, DL800
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

##### TSENS

###### TS1

Instance id: | MID_LAS_COM/TSENS/TS1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS2

Instance id: | MID_LAS_COM/TSENS/TS2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TS3

Instance id: | MID_LAS_COM/TSENS/TS3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### TRIGGER_CAM1

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM10

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM10
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM3

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM3
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM4

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM4
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM5

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM5
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM6

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM6
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM7

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM7
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM8

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM8
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM9

Instance id: | MID_LAS_COM/TSYS/TRIGGER_CAM9
Class id: | X2TimerML
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-11-27T19:21:58.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.3.4-2.10.0
Deployment tag: | 1.3.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

##### VALVE

###### LPS1

Instance id: | MID_LAS_COM/VALVE/LPS1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### LPS2

Instance id: | MID_LAS_COM/VALVE/LPS2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

##### CAM

[add component documentation]

###### CAM1

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

###### CAM10

Instance id: | MID_LAS_COM/CAM/CAM10
Host: | exflcon142
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-5
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
Scenes: | MID_LAS_COM/CAM/CAM10, MID_LAS_COM/CAM/CAM10
Accessible by: | CONTROLS, DA, scholzma

[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

###### CAM2

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

###### CAM3

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

###### CAM4

Instance id: | MID_LAS_COM/CAM/CAM4
Host: | exflcon142
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-5
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
Scenes: | MID_LAS_COM/CAM/CAM4, MID_LAS_COM/CAM/CAM4
Accessible by: | CONTROLS, DA, scholzma

[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

###### CAM5

Instance id: | MID_LAS_COM/CAM/CAM5
Host: | exflcon135
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-6
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
Scenes: | MID_LAS_COM/CAM/CAM5, MID_LAS_COM/CAM/CAM5
Accessible by: | CONTROLS, DA, scholzma

[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

###### CAM6

Instance id: | MID_LAS_COM/CAM/CAM6
Class id: | LimaBaslerCamera
Host: | exflcon142
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-11-24T11:43:54.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.6.9-2.10.0
Deployment tag: | 5.6.9-2.10.0
Scenes: | MID_LAS_COM/CAM/CAM6, MID_LAS_COM/CAM/CAM6, CAM6_Large
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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

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
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.6.9-2.10.0

Created: | 2020-11-24T11:03:00.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T13:03:07.000Z
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T07:21:15.000Z
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T07:18:28.000Z
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T09:00:15.000Z
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T07:10:27.000Z
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T16:47:56.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T13:52:54.000Z
Author: | Andrea Parenti
Notes: |

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

###### CAM7

Instance id: | MID_LAS_COM/CAM/CAM7
Host: | exflcon135
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-6
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
Scenes: | MID_LAS_COM/CAM/CAM7, MID_LAS_COM/CAM/CAM7
Accessible by: | CONTROLS, DA, scholzma

[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

###### CAM8

Instance id: | MID_LAS_COM/CAM/CAM8
Host: | exflcon142
Class documentation:
| LimaBaslerCamera
Alias: | mid-rr-sys-con-5
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
Scenes: | MID_LAS_COM/CAM/CAM8, MID_LAS_COM/CAM/CAM8
Accessible by: | CONTROLS, DA, scholzma

[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

###### CAM9

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

##### AVG

[add component documentation]

###### CAM1

Instance id: | MID_LAS_COM/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM10

Instance id: | MID_LAS_COM/AVG/CAM10
Host: | exflcon142
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM2

Instance id: | MID_LAS_COM/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM3

Instance id: | MID_LAS_COM/AVG/CAM3
Host: | exflcon135
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM4

Instance id: | MID_LAS_COM/AVG/CAM4
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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

###### CAM5

Instance id: | MID_LAS_COM/AVG/CAM5
Host: | exflcon135
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM6

Instance id: | MID_LAS_COM/AVG/CAM6
Class id: | ImageAverager
Host: | exflcon142
Alias: | mid-rr-sys-con-5
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM7

Instance id: | MID_LAS_COM/AVG/CAM7
Host: | exflcon135
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM8

Instance id: | MID_LAS_COM/AVG/CAM8
Host: | exflcon142
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM9

Instance id: | MID_LAS_COM/AVG/CAM9
Host: | exflcon135
Alias: | mid-rr-sys-con-6
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: | CONTROLS, DA, scholzma

[add instance documentation]

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_LAS_COM/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
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’, ‘midonc’]!

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.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.

###### CAM10

Instance id: | MID_LAS_COM/PROC/CAM10
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM2

Instance id: | MID_LAS_COM/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
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’, ‘midonc’]!

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.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.

###### CAM3

Instance id: | MID_LAS_COM/PROC/CAM3
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM4

Instance id: | MID_LAS_COM/PROC/CAM4
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM5

Instance id: | MID_LAS_COM/PROC/CAM5
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM6

Instance id: | MID_LAS_COM/PROC/CAM6
Class id: | ImageProcessor
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
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’, ‘midonc’]!

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.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.

###### CAM7

Instance id: | MID_LAS_COM/PROC/CAM7
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM8

Instance id: | MID_LAS_COM/PROC/CAM8
Host: | exflcon142
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

###### CAM9

Instance id: | MID_LAS_COM/PROC/CAM9
Host: | exflcon135
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-02-17T18:56:05.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.26.0-2.7.0
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Image Processor

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

Release History
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

1.14.0-2.3.2

Created: | 2019-01-29T12:35:23.000Z
Author: | Gabriele Giovanetti
Notes: | Added ImageThumbnail class

1.13.0-2.3.2

Created: | 2019-01-14T13:51:41.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessing version: 2.3.1-2.1 -> 2.3.3-2.3 Add documentation

##### MDL

[add component documentation]

###### ATT1_PERCENTS

#### PPL

[add component documentation]

##### MDL

[add component documentation]

###### MULTI_PATTERN

Instance id: | MID_LAS_PPL/MDL/MULTI_PATTERN
Class id: | PplMultiSubPattern
Host: | la1-br-ppl-con-pattern
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: | MID_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, MID_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, Macro_EXP_PPL, LAS_MAIN, MID_LAS_PPL/MDL/MULTI_PATTERN_ANGEL
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_PATTERN_OVERVIEW

### OPT

#### ALAS

##### DCTRL

###### PG1_A1

Instance id: | MID_OPT_ALAS/DCTRL/PG1_A1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_A2

Instance id: | MID_OPT_ALAS/DCTRL/PG1_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A2

Instance id: | MID_OPT_ALAS/DCTRL/PG2_A2
Class id: | BeckhoffDigitalOutput
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### PG2_C1

Instance id: | MID_OPT_ALAS/DCTRL/PG2_C1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PW1

Instance id: | MID_OPT_ALAS/DCTRL/PW1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Projects: | MID_OPT_ALAS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### GAUGE

###### PG1_A1

Instance id: | MID_OPT_ALAS/GAUGE/PG1_A1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_A2

Instance id: | MID_OPT_ALAS/GAUGE/PG1_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_C1

Instance id: | MID_OPT_ALAS/GAUGE/PG2_C1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_A2

Instance id: | MID_OPT_ALAS/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPARE_B2

Instance id: | MID_OPT_ALAS/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPARE_C1

Instance id: | MID_OPT_ALAS/GAUGE/SPARE_C1
Class id: | BeckhoffAnalogInput
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPARE_C2

Instance id: | MID_OPT_ALAS/GAUGE/SPARE_C2
Class id: | BeckhoffAnalogInput
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

##### ICTRL

###### IPCTRL

Instance id: | MID_OPT_ALAS/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_OPT_ALAS/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_ALAS_VAC, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_ALAS|scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### ALAS

Instance id: | MID_OPT_ALAS/MDL/ALAS
Class id: | MidAlignmentLaser
Host: | exflcon60n0
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/midAlignmentLaser
Last modified: | 2019-08-02T17:49:56.000+02:00
Created at: | 2018-12-19T10:29:15.000+01:00
Main authors: | Schaffer
Latest tag: | 1.0.0-2.3.2
Deployment tag: | 1.0.0-2.3.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- powerProxy:
    Karabo name of the power controls for this laser
- off:
    Turns the laser off
- on:
    Turns the laser on
- mirrTy:
    Controls for the TY motor in the vacuum
- mirr1T1:
    Horizontal tilt of the 1st optical mirror
- mirr1T2:
    Vertical tilt of the 1st optical mirror
- mirr2T1:
    Horizontal tilt of the 2nd optical mirror
- mirr2T2:
    Vertical tilt of the 2nd optical mirror
- lasy:
    Controls for the LASY motor, changing the height of thebeam
- fw1:
    Controls for the filter wheel in the alignment laser
- imagerLocation:
    Location of imager which detects the laser, ifapplicable
- stopAll:
    Orders all motors to stop

Release History
1.0.0-2.3.2

Created: | 2019-02-15T09:16:34.000Z
Author: | Robert Schaffer
Notes: | First implementation of device

##### MOTOR

###### FW1

###### LASY

###### MIRR1_T1

###### MIRR1_T2

###### MIRR2_T1

###### MIRR2_T2

###### MIRRTY

##### VALVE

###### GVD

Instance id: | MID_OPT_ALAS/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_ALAS_VAC, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_MONO|scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_ALAS|scene, MID_OT_VAC/VS/VS_MONO|scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### GVU

Instance id: | MID_OPT_ALAS/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_ALAS_VAC, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_ALAS|scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### BIAS

##### DCTRL

###### ILOCK_01

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_02

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_03

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_03
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_04

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_04
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_05

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_05
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_06

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_06
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_07

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_07
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### ILOCK_08

Instance id: | MID_OPT_BIAS/DCTRL/ILOCK_08
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### MONO

##### ACTRL

###### TOP_XTAL_FPITCH

Instance id: | MID_OPT_MONO/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ASENS

###### TOP_XTAL_FPITCH

Instance id: | MID_OPT_MONO/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene, MID_OPT_MONO/ASENS/TOP_XTAL_FPITCH|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### AVG

###### BEAMVIEW

Instance id: | MID_OPT_MONO/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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: | MID_OPT_MONO/CAM/Imager_Main
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### ROLLVIEW

Instance id: | MID_OPT_MONO/AVG/ROLLVIEW
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### SIDEVIEW

Instance id: | MID_OPT_MONO/AVG/SIDEVIEW
Class id: | ImageAverager
Host: | exflcon170
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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

###### BEAMVIEW

GENICAM CAMERAS

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

###### ROLLVIEW

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

###### SIDEVIEW

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

##### DCTRL

###### CAM

Instance id: | MID_OPT_MONO/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CRYO

Instance id: | MID_OPT_MONO/DCTRL/CRYO
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### HT1_ENABLE

Instance id: | MID_OPT_MONO/DCTRL/HT1_ENABLE
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT1_IS_LOC

Instance id: | MID_OPT_MONO/DCTRL/HT1_IS_LOC
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HT1_I_MON

Instance id: | MID_OPT_MONO/DCTRL/HT1_I_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT1_I_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT1_I_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### HT1_REM_SEL

Instance id: | MID_OPT_MONO/DCTRL/HT1_REM_SEL
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT1_V_MON

Instance id: | MID_OPT_MONO/DCTRL/HT1_V_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT1_V_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT1_V_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### HT2_ENABLE

Instance id: | MID_OPT_MONO/DCTRL/HT2_ENABLE
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT2_IS_LOC

Instance id: | MID_OPT_MONO/DCTRL/HT2_IS_LOC
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HT2_I_MON

Instance id: | MID_OPT_MONO/DCTRL/HT2_I_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT2_I_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT2_I_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### HT2_REM_SEL

Instance id: | MID_OPT_MONO/DCTRL/HT2_REM_SEL
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT2_V_MON

Instance id: | MID_OPT_MONO/DCTRL/HT2_V_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT2_V_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT2_V_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### HT3_ENABLE

Instance id: | MID_OPT_MONO/DCTRL/HT3_ENABLE
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT3_IS_LOC

Instance id: | MID_OPT_MONO/DCTRL/HT3_IS_LOC
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HT3_I_MON

Instance id: | MID_OPT_MONO/DCTRL/HT3_I_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT3_I_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT3_I_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### HT3_REM_SEL

Instance id: | MID_OPT_MONO/DCTRL/HT3_REM_SEL
Host: | exflcon60n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### HT3_V_MON

Instance id: | MID_OPT_MONO/DCTRL/HT3_V_MON
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### HT3_V_PROG

Instance id: | MID_OPT_MONO/DCTRL/HT3_V_PROG
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-10-28T14:42:56.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Mohacsi
Latest tag: | 4.3.10-2.6.1
Deployment tag: | 4.3.8-2.6.1
Installed tag: | 4.3.8-2.6.1
Accessible by: | CONTROLS, DA, scholzma

###### BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

###### PG1_C1

Instance id: | MID_OPT_MONO/DCTRL/PG1_C1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A1

Instance id: | MID_OPT_MONO/DCTRL/PG2_A1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_A2

Instance id: | MID_OPT_MONO/DCTRL/SPARE_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_B1

Instance id: | MID_OPT_MONO/DCTRL/SPARE_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_B2

Instance id: | MID_OPT_MONO/DCTRL/SPARE_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_C2

Instance id: | MID_OPT_MONO/DCTRL/SPARE_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### TOP_XTAL_ROLL_LIDLE

Instance id: | MID_OPT_MONO/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### TOP_XTAL_ROLL_ON

Instance id: | MID_OPT_MONO/DCTRL/TOP_XTAL_ROLL_ON
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | MID_OPT_MONO/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### TOP_XTAL_RPITCH_ON

Instance id: | MID_OPT_MONO/DCTRL/TOP_XTAL_RPITCH_ON
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### LED

##### GAUGE

###### PG1_C1

Instance id: | MID_OPT_MONO/GAUGE/PG1_C1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A1

Instance id: | MID_OPT_MONO/GAUGE/PG2_A1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A2

Instance id: | MID_OPT_MONO/GAUGE/PG2_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_A2

Instance id: | MID_OPT_MONO/GAUGE/SPARE_A2
Class id: | BeckhoffAnalogInput
Host: | exflcon60n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-04T16:39:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- 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 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.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### SPARE_B1

Instance id: | MID_OPT_MONO/GAUGE/SPARE_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_B2

Instance id: | MID_OPT_MONO/GAUGE/SPARE_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### SPARE_C2

Instance id: | MID_OPT_MONO/GAUGE/SPARE_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ICTRL

###### IPCTRL

Instance id: | MID_OPT_MONO/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OT_VAC/VS/VS_MONO|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_OPT_MONO/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OT_VAC/VS/VS_MONO|scene, MID_OPT_MONO/Temperature_Control, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### KARABACON

Instance id: | MID_OPT_MONO/MDL/KARABACON
Host: | exflcon148
Class documentation:
| Karabacon
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2020-02-19T16:18:19.000+01:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mohacsi
Latest tag: | 2.2.2-2.7.0
Deployment tag: | 1.6.1-2.6.0
Installed tag: | 1.6.1-2.6.0
Scenes: | MID_OPT_MONO/MDL/KARABACON|MainControl, MID_OPT_MONO/MDL/KARABACON|Plot
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
2.2.2-2.7.0

Created: | 2020-01-30T13:18:22.000Z
Author: | Istvan Mohacsi
Notes: |

2.2.1-2.7.0

Created: | 2019-12-16T12:53:17.000Z
Author: | Dennis Goeries
Notes: |

2.2.0-2.7.0

Created: | 2019-12-04T15:15:33.000Z
Author: | Dennis Goeries
Notes: |

1.6.1-2.6.0

Created: | 2019-10-02T16:15:26.000Z
Author: | Wajid Ehsan
Notes: | Include pplaserDelayCopy Device.

1.6.0-2.6.0

Created: | 2019-09-11T14:54:42.000Z
Author: | Dennis Goeries
Notes: |

1.5.0-2.6.0

Created: | 2019-06-04T12:03:20.000Z
Author: | Dennis Goeries
Notes: |

1.4.6-2.4.0

Created: | 2019-05-28T09:43:44.000Z
Author: | Wajid Ehsan
Notes: | Include APD class from BeamPositionMonitor Device

1.4.5-2.4.0

Created: | 2019-05-17T17:47:43.000Z
Author: | David Hickin
Notes: | Include Doocs undulator class

1.4.4-2.4.0

Created: | 2019-05-14T13:13:03.000Z
Author: | Robert Schaffer
Notes: | Added proxy processor device, for cross topic scans

1.4.3-2.4.0

Created: | 2019-05-07T12:35:12.000Z
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-05-07T09:08:03.000Z
Author: | Dennis Goeries
Notes: |

1.3.19-2.4.0

Created: | 2019-04-26T14:24:42.000Z
Author: | Dennis Goeries
Notes: |

1.3.18-2.4.0

Created: | 2019-04-09T11:29:37.000Z
Author: | Wajid Ehsan
Notes: | Integration of monoChromator device

1.3.17-2.4.0

Created: | 2019-03-26T08:35:20.000Z
Author: | David Hickin
Notes: |

1.3.16-2.4.0

Created: | 2019-03-26T08:35:20.000Z
Author: | David Hickin
Notes: |

1.3.12-2.3

Created: | 2018-12-17T16:06:26.000Z
Author: | Gabriele Giovanetti
Notes: | fix for genericAverage i/f

1.3.11-2.2.5

Created: | 2018-10-24T15:20:42.000Z
Author: | Wajid Ehsan
Notes: |

1.3.9-2.2.4-hotfix

Created: | 2018-10-16T15:30:29.000Z
Author: | Wajid Ehsan
Notes: |

1.3.10-2.2.5

Created: | 2018-09-27T12:56:31.000Z
Author: | Dennis Goeries
Notes: | genericAverage I/F for SPB pulse picker scans

1.3.9-2.2.4

Created: | 2018-09-22T14:01:19.000Z
Author: | Wajid Ehsan
Notes: | Integrate Doocs Pulse Kicker device

##### MOTOR

###### ACCM_PITCH

###### TOP_XTAL_ROLL

Instance id: | MID_OPT_MONO/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Note

The velocity for this motor has been commissioned!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### TOP_XTAL_RPITCH

Instance id: | MID_OPT_MONO/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Note

The velocity for this motor has been commissioned!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

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
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- 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.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

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

###### TX

###### TY

###### TOP_XTRAL_RPITCH_SM

##### PROC

###### BEAMVIEW

Instance id: | MID_OPT_MONO/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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: | MID_OPT_MONO/CAM/Imager_Main, BeamPosition
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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.

###### ROLLVIEW

Instance id: | MID_OPT_MONO/PROC/ROLLVIEW
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

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.

###### SIDEVIEW

Instance id: | MID_OPT_MONO/PROC/SIDEVIEW
Class id: | ImageProcessor
Host: | exflcon170
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-12
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’, ‘midonc’]!

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.

##### PSC

###### HT1

Instance id: | MID_OPT_MONO/PSC/HT1
Class id: | BeckhoffGeneric
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.

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

###### HT2

Instance id: | MID_OPT_MONO/PSC/HT2
Class id: | BeckhoffGeneric
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.

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

###### HT3

Instance id: | MID_OPT_MONO/PSC/HT3
Class id: | BeckhoffGeneric
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.

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

##### SWITCH

###### TOP_XTAL_ROLL_LFAULT

Instance id: | MID_OPT_MONO/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### TOP_XTAL_ROLL_TEMP

Instance id: | MID_OPT_MONO/SWITCH/TOP_XTAL_ROLL_TEMP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | MID_OPT_MONO/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### TOP_XTAL_RPITCH_TEMP

Instance id: | MID_OPT_MONO/SWITCH/TOP_XTAL_RPITCH_TEMP
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

##### TSENS

###### PT1

Instance id: | MID_OPT_MONO/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperatures, MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PT2

Instance id: | MID_OPT_MONO/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperatures, MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PT3

Instance id: | MID_OPT_MONO/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_MONO/Temperatures, MID_OPT_MONO/Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### TRIGGER

Instance id: | MID_OPT_MONO/TSYS/TRIGGER
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### VALVE

###### GVU

Instance id: | MID_OPT_MONO/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_AUXT2|scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_MONO|scene, OPT_main_Vacuum_scene, MID_OT_VAC/VS/VS_MONO|scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### SHUT

##### DCTRL

###### PG1_B1

Instance id: | MID_OPT_SHUT/DCTRL/PG1_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_B1_HIGH

Instance id: | MID_OPT_SHUT/DCTRL/PG1_B1_HIGH
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_B1_LOW

Instance id: | MID_OPT_SHUT/DCTRL/PG1_B1_LOW
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_B2

Instance id: | MID_OPT_SHUT/DCTRL/PG1_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_C2

Instance id: | MID_OPT_SHUT/DCTRL/PG2_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### GAUGE

###### PG1_B1

Instance id: | MID_OPT_SHUT/GAUGE/PG1_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_B2

Instance id: | MID_OPT_SHUT/GAUGE/PG1_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_C2

Instance id: | MID_OPT_SHUT/GAUGE/PG2_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ICTRL

###### IPCTRL

Instance id: | MID_OPT_SHUT/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_OPT_VAC/VS/VS_SHUT|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_OPT_SHUT/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_SHUT|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### SWITCH

###### PG1_B1_HIGH

Instance id: | MID_OPT_SHUT/SWITCH/PG1_B1_HIGH
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### PG1_B1_LOW

Instance id: | MID_OPT_SHUT/SWITCH/PG1_B1_LOW
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- resetCounterRegister:
    Internal

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

###### GVD

Instance id: | MID_OPT_SHUT/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_SHUT|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### GVU

Instance id: | MID_OPT_SHUT/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, MID_OPT_VAC/VS/VS_SHUT|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

#### VAC

##### 2

Instance id: | MID_OPT_VAC/2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

###### 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

###### PG1

Instance id: | MID_OPT_VAC/GAUGE/PG1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG_RESERVE1

Instance id: | MID_OPT_VAC/GAUGE/PG_RESERVE1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | ChristmasSDL_Observer
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ICTRL

###### IPCTRL

Instance id: | MID_OPT_VAC/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

###### IP1

Instance id: | MID_OPT_VAC/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### IP_RESERVE

Instance id: | MID_OPT_VAC/IPUMP/IP_RESERVE
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### VS_GROUP

Instance id: | MID_OPT_VAC/MDL/VS_GROUP
Class id: | VacuumSectionGroup
Host: | mid-rr-sys-con-1
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/vacuumSection
Last modified: | 2021-05-26T12:12:54.000+02:00
Created at: | 2016-11-16T14:10:37.000+01:00
Main authors: | Haufs, Schaffer, Ehsan
Latest tag: | 2.2.0-2.11.0
Deployment tag: | 2.2.0-2.11.0
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- poll_policy:
    Poll policy of ion-pump and gauge device properties
- reset_vacuum_sections:
    Resets vacuum section devices in ERROR and requests their h/w values from PLC

Release History
2.2.0-2.11.0

Created: | 2021-05-26T12:14:25.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.8-2.10.0

Created: | 2020-11-24T12:51:57.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.1.7-2.5.0

Created: | 2019-07-16T17:12:15.000+02:00
Author: | Christopher Youngman
Notes: | added turbo pumps device and table

2.1.6-2.4.0

Created: | 2019-07-03T12:26:24.000+02:00
Author: | Christopher Youngman
Notes: | Adds INITONLY settable time between requests property and some bookkeeping with it to avoid/see KaraboError occurances.

2.1.5-2.4.0

Created: | 2019-07-02T15:07:15.000+02:00
Author: | Christopher Youngman
Notes: | Catches KaraboError exception and continues if VacuumSection ‘reset’ and ‘request_hw_values’ slot calls throw the exception.

2.1.4-2.4.0

Created: | 2019-05-27T11:07:24.000+02:00
Author: | Christopher Youngman
Notes: | Adds additional MDL device above the VacuumSection called VacuumSectionGroup, whose table element lists VacuumSetction to receive ‘Reset’ followed by ‘Request h/w values’ when ‘Force Refresh’ is fired.

2.1.3-2.4.0

Created: | 2019-05-09T15:53:20.000+02:00
Author: | Robert Schaffer
Notes: | Added units to the agilent ion-pump properties

2.1.2-2.3.2

Created: | 2019-01-11T16:12:52.000+01:00
Author: | Robert Schaffer
Notes: | Added a workaround for the table-element bug, which is to be addressed in karabo-2.3.3. Also improved error handling for this table element (may be also handled by the bugfix).

2.1.1-2.2.5

Created: | 2018-10-15T14:01:43.000+02:00
Author: | Valerii Bondar
Notes: | Version with scene generation. Was successfully tested in tunnel.

2.1.0-2.2.4

Created: | 2018-03-27T14:08:25.000+02:00
Author: | Dennis Goeries
Notes: | Device Scene added

2.0.5-2.2.1

Created: | 2018-02-16T10:55:20.000+01:00
Author: | Christopher Youngman
Notes: | Remove superfluous state set

2.0.4-2.2.1

Created: | 2018-02-05T15:42:06.000+01:00
Author: | Christopher Youngman
Notes: | Exposes aggregated ion-pump and guage alarm and state as those of the VS device

2.0.3-2.1

Created: | 2017-06-20T09:51:51.000+02:00
Author: | Dennis Goeries
Notes: |

2.0

Created: | 2016-12-12T19:08:12.000+01:00
Author: | Alessandro Silenzi
Notes: | running version with karabo 2.0. This is tagged for old compatiblity since a new version is coming up.

2.0.2-1.4

Created: | 2016-11-30T10:02:37.000+01:00
Author: | Wajid Ehsan
Notes: | version 1.4

0.1.0-1.4

Created: | 2016-11-04T15:04:02.000+00:00
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/0.1.0-1.4” via karabo script

tags

Created: | 2016-11-04T14:17:55.000+00:00
Author: | silenzi
Notes: | Package SASE1VacuumSection got tagged from “trunk” to “tags/tags/0.1.0-1.4” via karabo script

##### VALVE

###### GV_RESERVE1

Instance id: | MID_OPT_VAC/VALVE/GV_RESERVE1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### GV_RESERVE2

Instance id: | MID_OPT_VAC/VALVE/GV_RESERVE2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### VS

###### VS_A03

###### VS_ALAS

###### VS_AUXT1

###### VS_AUXT2

###### VS_MONO

###### VS_OPTVAC

###### VS_SDL

###### VS_SHUT

#### SDL

##### ASENS

###### AUX_ANI01

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI01
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI02

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI02
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI03

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI03
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI04

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI04
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI05

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI05
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI06

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI06
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI07

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI07
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI08

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI08
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI09

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI09
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI10

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI10
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI11

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI11
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI12

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI12
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI13

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI13
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI14

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI14
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI15

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI15
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_ANI16

Instance id: | MID_OPT_SDL/ASENS/AUX_ANI16
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT01

Instance id: | MID_OPT_SDL/ASENS/AUX_HT01
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT02

Instance id: | MID_OPT_SDL/ASENS/AUX_HT02
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT03

Instance id: | MID_OPT_SDL/ASENS/AUX_HT03
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT04

Instance id: | MID_OPT_SDL/ASENS/AUX_HT04
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT05

Instance id: | MID_OPT_SDL/ASENS/AUX_HT05
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT06

Instance id: | MID_OPT_SDL/ASENS/AUX_HT06
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT07

Instance id: | MID_OPT_SDL/ASENS/AUX_HT07
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT08

Instance id: | MID_OPT_SDL/ASENS/AUX_HT08
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT09

Instance id: | MID_OPT_SDL/ASENS/AUX_HT09
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_HT10

Instance id: | MID_OPT_SDL/ASENS/AUX_HT10
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM1_HT1

Instance id: | MID_OPT_SDL/ASENS/BM1_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM1_HT2

Instance id: | MID_OPT_SDL/ASENS/BM1_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM1_HT3

Instance id: | MID_OPT_SDL/ASENS/BM1_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM2_HT1

Instance id: | MID_OPT_SDL/ASENS/BM2_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM2_HT2

Instance id: | MID_OPT_SDL/ASENS/BM2_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BM2_HT3

Instance id: | MID_OPT_SDL/ASENS/BM2_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS1_HT1

Instance id: | MID_OPT_SDL/ASENS/BS1_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS1_HT2

Instance id: | MID_OPT_SDL/ASENS/BS1_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS1_HT3

Instance id: | MID_OPT_SDL/ASENS/BS1_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS2_HT1

Instance id: | MID_OPT_SDL/ASENS/BS2_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS2_HT2

Instance id: | MID_OPT_SDL/ASENS/BS2_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### BS2_HT3

Instance id: | MID_OPT_SDL/ASENS/BS2_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC1_HT1

Instance id: | MID_OPT_SDL/ASENS/CC1_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC1_HT2

Instance id: | MID_OPT_SDL/ASENS/CC1_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC1_HT3

Instance id: | MID_OPT_SDL/ASENS/CC1_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC2_HT1

Instance id: | MID_OPT_SDL/ASENS/CC2_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC2_HT2

Instance id: | MID_OPT_SDL/ASENS/CC2_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CC2_HT3

Instance id: | MID_OPT_SDL/ASENS/CC2_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC1_HT1

Instance id: | MID_OPT_SDL/ASENS/DC1_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC1_HT2

Instance id: | MID_OPT_SDL/ASENS/DC1_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC1_HT3

Instance id: | MID_OPT_SDL/ASENS/DC1_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC1_TEMP4

Instance id: | MID_OPT_SDL/ASENS/DC1_TEMP4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC1_TEMP5

Instance id: | MID_OPT_SDL/ASENS/DC1_TEMP5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC2_HT1

Instance id: | MID_OPT_SDL/ASENS/DC2_HT1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC2_HT2

Instance id: | MID_OPT_SDL/ASENS/DC2_HT2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC2_HT3

Instance id: | MID_OPT_SDL/ASENS/DC2_HT3
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC2_TEMP4

Instance id: | MID_OPT_SDL/ASENS/DC2_TEMP4
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### DC2_TEMP5

Instance id: | MID_OPT_SDL/ASENS/DC2_TEMP5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### CHILL

###### LI_CHILL

Instance id: | MID_OPT_SDL/CHILL/LI_CHILL
Class id: | BeckhoffChiller
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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:
    Start Cooling
- off:
    Stop Cooling
- maxTemp:
    Maximum Temperature range of the Chiller - Inclusive
- minTemp:
    Minimum Temperature range of the Chiller - Inclusive
- deadband:
    Allowable deadband of the Chiller to be considered at setpoint
- warningFactor:
    Warning time factor used to determine the expected duration where the chiller should reach the expected setpoint
- roomTemp:
    Room Temperature - the chiller needs to reach room temperature before it can safely turn off
- chillerType:
    Manufacturer of the Chiller. 0=Huber, 1=Julabo. This must be configured during implementation for the initialization of the soft device.
- rampRate:
    If set to > 0, the chiller will reach the final setpoint at the given rate of X deg_C/minute
- offset:
    Calibration Offset
- filterTime:
    Filter Timer for error signals

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

##### DCTRL

###### AUX_CAM1

Instance id: | MID_OPT_SDL/DCTRL/AUX_CAM1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_CAM2

Instance id: | MID_OPT_SDL/DCTRL/AUX_CAM2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_CAM3

Instance id: | MID_OPT_SDL/DCTRL/AUX_CAM3
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### AUX_CAM4

Instance id: | MID_OPT_SDL/DCTRL/AUX_CAM4
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### FBL_CAM

Instance id: | MID_OPT_SDL/DCTRL/FBL_CAM
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_SDL-CAM_YAGscreens_old, MID_SDL-CAM_temp0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### LI_LASER_RELAIS

Instance id: | MID_OPT_SDL/DCTRL/LI_LASER_RELAIS
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG1_C1

Instance id: | MID_OPT_SDL/DCTRL/PG1_C1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A1

Instance id: | MID_OPT_SDL/DCTRL/PG2_A1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A2

Instance id: | MID_OPT_SDL/DCTRL/PG2_A2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG3_C2

Instance id: | MID_OPT_SDL/DCTRL/PG3_C2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_B1

Instance id: | MID_OPT_SDL/DCTRL/PG4_B1
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_B2

Instance id: | MID_OPT_SDL/DCTRL/PG4_B2
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### LIGHT-1

###### LIGHT-2

###### LIGHT-3

###### LIGHT-4

###### CAM5

Instance id: | MID_OPT_SDL/DCTRL/CAM5
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CAM6

Instance id: | MID_OPT_SDL/DCTRL/CAM6
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### CAM7

Instance id: | MID_OPT_SDL/DCTRL/CAM7
Class id: | BeckhoffDigitalOutput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### MOTOR

###### AUX_MOT1

###### AUX_MOT10

###### AUX_MOT2

###### AUX_MOT3

###### AUX_MOT4

###### AUX_MOT5

###### AUX_MOT6

###### AUX_MOT7

###### AUX_MOT8

###### AUX_MOT9

###### BM1_CAS

###### BM1_CAT

###### BM1_FA1

###### BM1_FA2

###### BM1_FA3

###### BM1_FA4

###### BM1_FA5

###### BM1_FA6

###### BM1_FBM1

###### BM1_FBM2

###### BM2_CAS

###### BM2_CAT

###### BM2_FA1

###### BM2_FA2

###### BM2_FA3

###### BM2_FA4

###### BM2_FA5

###### BM2_FA6

###### BM2_FBM1

###### BM2_FBM2

###### BMS1_SH

###### BMS2_SH

###### BMS3_SH

###### BMS4_SH

###### BMS5_SH

###### BS1_CAS

###### BS1_CAT

###### BS1_FA1

###### BS1_FA2

###### BS1_FA3

###### BS1_FA4

###### BS1_FA5

###### BS1_FA6

###### BS1_FBM1

###### BS1_FBM2

###### BS2_CAS

###### BS2_CAT

###### BS2_FA1

###### BS2_FA2

###### BS2_FA3

###### BS2_FA4

###### BS2_FA5

###### BS2_FA6

###### BS2_FBM1

###### BS2_FBM2

###### CC1_CAS

###### CC1_CAT

###### CC1_FA1

###### CC1_FA2

###### CC1_FA3

###### CC1_FA4

###### CC1_FA5

###### CC1_FA6

###### CC2_CAS

###### CC2_CAT

###### CC2_FA1

###### CC2_FA2

###### CC2_FA3

###### CC2_FA4

###### CC2_FA5

###### CC2_FA6

###### DC1_CASY

###### DC1_CASZ

###### DC1_CAT

###### DC1_DA

###### DC1_FA1

###### DC1_FA2

###### DC1_FA3

###### DC1_FA4

###### DC1_FA5

###### DC1_FA6

###### DC1_FBM1

###### DC1_FBM2

###### DC2_CASY

###### DC2_CASZ

###### DC2_CAT

###### DC2_DA

###### DC2_FA1

###### DC2_FA2

###### DC2_FA3

###### DC2_FA4

###### DC2_FA5

###### DC2_FA6

###### DC2_FBM1

###### DC2_FBM2

###### FBL_AL1

###### FBL_AL2

###### FBL_AL3

###### FBL_AL4

###### FBL_AL5

###### FBL_AL6

###### LI1_AL1

###### LI1_AL2

###### LI1_AL3

###### LI1_AL4

###### LI1_AL5

###### LI1_AL6

###### LI1_IR1

###### LI1_IR2

###### LI2_AL1

###### LI2_AL2

###### LI2_AL3

###### LI2_AL4

###### LI2_AL5

###### LI2_AL6

###### LI2_IR1

###### LI2_IR2

###### LI_AIRL01

###### LI_AIRL02

###### LI_AIRL03

###### LI_AIRL04

###### LI_AIRL05

###### LI_AIRL06

###### LI_AIRL07

###### LI_AIRL08

###### LI_AIRL09

###### LI_AIRL10

##### SWITCH

###### AUX_DIG1

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG1
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG2

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG2
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG3

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG3
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG4

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG4
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG5

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG5
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG6

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG6
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG7

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG7
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### AUX_DIG8

Instance id: | MID_OPT_SDL/SWITCH/AUX_DIG8
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

###### LI_LASER_RELAIS

Instance id: | MID_OPT_SDL/SWITCH/LI_LASER_RELAIS
Class id: | BeckhoffDigitalInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- resetCounterRegister:
    Internal

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

##### TSENS

###### TEMP_BATH

Instance id: | MID_OPT_SDL/TSENS/TEMP_BATH
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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_HEAT

Instance id: | MID_OPT_SDL/TSENS/TEMP_HEAT
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### 2

Instance id: | MID_OPT_SDL/2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

###### 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]

###### PG1_C1

Instance id: | MID_OPT_SDL/GAUGE/PG1_C1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A1

Instance id: | MID_OPT_SDL/GAUGE/PG2_A1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, SDL_Pressure, OPT_main_Vacuum_scene, MID_SDL-Control_Coarse, SDL_Pressure2, SDL_Pressure2_new02, MID_SDL-Vacuum_Pressure, MID_SDL-Control_Coarse2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG2_A2

Instance id: | MID_OPT_SDL/GAUGE/PG2_A2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG3_C2

Instance id: | MID_OPT_SDL/GAUGE/PG3_C2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_B1

Instance id: | MID_OPT_SDL/GAUGE/PG4_B1
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene, SDL_Pressure, OPT_main_Vacuum_scene, MID_SDL-Control_Coarse, SDL_Pressure2, SDL_Pressure2_new02, MID_SDL-Vacuum_Pressure, MID_SDL-Control_Coarse2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG4_B2

Instance id: | MID_OPT_SDL/GAUGE/PG4_B2
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG5

Instance id: | MID_OPT_SDL/GAUGE/PG5
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | SDL_Pressure, OPT_main_Vacuum_scene, MID_SDL-Control_Coarse, SDL_Pressure2, SDL_Pressure2_new02, MID_SDL-Vacuum_Pressure, MID_SDL-Control_Coarse2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG6

Instance id: | MID_OPT_SDL/GAUGE/PG6
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | SDL_Pressure, OPT_main_Vacuum_scene, MID_SDL-Control_Coarse, SDL_Pressure2, SDL_Pressure2_new02, MID_SDL-Vacuum_Pressure, MID_SDL-Control_Coarse2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### PG7

Instance id: | MID_OPT_SDL/GAUGE/PG7
Class id: | BeckhoffAnalogInput
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | SDL_Pressure, OPT_main_Vacuum_scene, MID_SDL-Control_Coarse, SDL_Pressure2, SDL_Pressure2_new02, MID_SDL-Vacuum_Pressure, MID_SDL-Control_Coarse2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### ICTRL

[add component documentation]

###### IPCTRL

Instance id: | MID_OPT_SDL/ICTRL/IPCTRL
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

##### IPUMP

[add component documentation]

###### IP1

Instance id: | MID_OPT_SDL/IPUMP/IP1
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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

###### IP2

Instance id: | MID_OPT_SDL/IPUMP/IP2
Class id: | BeckhoffAgilentIonPump
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

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]

###### BS1_FA_STAGE

Release History

###### CC1_FA_STAGE

Release History

###### CC1_GROUP

###### AL2_AL_STAGE

Release History

###### BM1_FA_STAGE

Release History

###### BM1_GROUP

###### BM2_FA_STAGE

Release History

###### BM2_GROUP

###### BS1_GROUP

###### BS2_FA_STAGE

Release History

###### BS2_GROUP

###### CC2_FA_STAGE

Release History

###### CC2_GROUP

###### DC1_FA_STAGE

Release History

###### DC1_GROUP

###### DC2_FA_STAGE

Release History

###### DC2_GROUP

###### LI1_AL_STAGE

Release History

###### LI1_GROUP

###### LI2_GROUP

###### WATCHDOG_BM1

###### WATCHDOG_BS1

###### WATCHDOG_CC1

###### WATCHDOG_CC2

###### WATCHDOG_DC

###### WATCHDOG_DC1

###### WATCHDOG_DC1_DIODE

###### WATCHDOG_DC2

###### WATCHDOG_DC2_DIODE

###### DELAY_TUNER

###### DELAY_TUNER_2MCOARSE

###### DELAY_TUNER_4MCOARSE

###### CAMERA_SHAKER

##### TPUMP

[add component documentation]

###### TPCTRL

Instance id: | MID_OPT_SDL/TPUMP/TPCTRL
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 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

[add component documentation]

###### GVD

Instance id: | MID_OPT_SDL/VALVE/GVD
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### GVTP

Instance id: | MID_OPT_SDL/VALVE/GVTP
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### GVU

Instance id: | MID_OPT_SDL/VALVE/GVU
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | OPT_main_Vacuum_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### RV1

Instance id: | MID_OPT_SDL/VALVE/RV1
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Scenes: | MID_SDL-CAM_YAGscreens_old, MID_SDL-CAM_temp0, MID_SDL-CAM_YAGscreens, MID_SDL-CAM_mechanics, temp_cam, MID_SDL-CAM_BMS40
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### RV2

Instance id: | MID_OPT_SDL/VALVE/RV2
Class id: | BeckhoffValve
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

##### AVG

[add component documentation]

###### CAM3

Instance id: | MID_OPT_SDL/AVG/CAM3
Class id: | ImageAverager
Host: | exflcon187
Alias: | mid-rr-sys-con-14
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: | CAM_temp_old, MID_SDL-CAM_YAGscreens_old, MID_SDL-CAM_temp0, MID_SDL-CAM_YAGscreens
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM1

Instance id: | MID_OPT_SDL/AVG/CAM1
Class id: | ImageAverager
Host: | exflcon187
Alias: | mid-rr-sys-con-14
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: | CAM_temp_old, MID_SDL-CAM_YAGscreens_old, MID_SDL-CAM_temp0, MID_SDL-CAM_YAGscreens
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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.

###### CAM2

Instance id: | MID_OPT_SDL/AVG/CAM2
Class id: | ImageAverager
Host: | exflcon187
Alias: | mid-rr-sys-con-14
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: | CAM_temp_old, MID_SDL-CAM_YAGscreens_old, MID_SDL-CAM_temp0, MID_SDL-CAM_YAGscreens
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

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]

###### CAM2

GENICAM CAMERAS

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

###### CAM1

GENICAM CAMERAS

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

###### CAM3

GENICAM CAMERAS

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

###### CAM4

GENICAM CAMERAS

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

###### CAM5

GENICAM CAMERAS

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

###### CAM6

GENICAM CAMERAS

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

###### CAM7

GENICAM CAMERAS

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

###### FBL_CAM

GENICAM CAMERAS

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

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_OPT_SDL/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon187
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-14
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’, ‘midonc’]!

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.

###### CAM3

Instance id: | MID_OPT_SDL/PROC/CAM3
Class id: | ImageProcessor
Host: | exflcon187
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-14
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’, ‘midonc’]!

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.

###### CAM2

Instance id: | MID_OPT_SDL/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon187
Class documentation:
| ImageProcessor
Alias: | mid-rr-sys-con-14
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’, ‘midonc’]!

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.

##### TSYS

[add component documentation]

###### TRIGGER_CAM1

Instance id: | MID_OPT_SDL/TSYS/TRIGGER_CAM1
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM2

Instance id: | MID_OPT_SDL/TSYS/TRIGGER_CAM2
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### TRIGGER_CAM3

Instance id: | MID_OPT_SDL/TSYS/TRIGGER_CAM3
Class id: | X2TimerML
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml: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
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### POE

[add component documentation]

###### CAM1

###### CAM2

### RR

#### SYS

##### CON

###### MONITOR1

Instance id: | MID_RR_SYS/CON/MONITOR1
Class id: | ControlServerMonitor
Host: | exflcon60n0
Alias: | mid-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2020-11-26T12:25:14.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Fabbri, Haufs, Schaffer
Latest tag: | 1.0.2-2.10.0
Deployment tag: | 1.0.2-2.10.0
Scenes: | Global_CPU, Global_MEM
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- autoStart:
    The device automatically starts this long afterinstantiation. Set to -1 to prevent automaticinstantiation.
- serverScope:
    Scope of the servers whose data is logged:
      Karabo Environment refers to all device servers monitored by this Karabo environment, while Control Server Machine refers to all device servers on this machine. Control Server Machine will not give information about environments for which this user lacks access permission.
- updateTime:
    The time between subsequent property updates. This shouldbe set to at least .5
- start:
    Begins data logging
- stop:
    Ends data gathering
- totCpuUsage:
    The average CPU usage for this computer, since the lastupdate - this should always be between 0 and 100%
- swapped:
    Amount of memory in swap
- swappedPercent:
    Percent of total swap space used
- availableMemory:
    The amount of memory which is available for allocation
- memoryUsagePercent:
    Percent of total physical memory used
- buffed:
    The allocated memory in use
- cache:
    The size of the memory cache used
- counter:
    Counts the number of updates the device has made since
      it was started. Resets to zero when updates stop.
- totalMemMB:
    Amount of physical memory present on the system
- totalSwapMB:
    Total swap space present on the system

Release History
1.0.2-2.10.0

Created: | 2020-11-26T11:29:56.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR10

Instance id: | MID_RR_SYS/CON/MONITOR10
Host: | exflcon139
Alias: | mid-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR11

Instance id: | MID_RR_SYS/CON/MONITOR11
Host: | exflcon131
Alias: | mid-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR2

Instance id: | MID_RR_SYS/CON/MONITOR2
Host: | exflcon61n0
Alias: | mid-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR3

Instance id: | MID_RR_SYS/CON/MONITOR3
Host: | exflcon141
Alias: | mid-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR4

Instance id: | MID_RR_SYS/CON/MONITOR4
Host: | exflcon138
Alias: | mid-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR5

Instance id: | MID_RR_SYS/CON/MONITOR5
Host: | exflcon142
Alias: | mid-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR6

Instance id: | MID_RR_SYS/CON/MONITOR6
Host: | exflcon135
Alias: | mid-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR9

Instance id: | MID_RR_SYS/CON/MONITOR9
Host: | exflcon161
Alias: | mid-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, amunnich, jsztuk, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR12

Instance id: | MID_RR_SYS_CON/MONITOR12
Host: | exflcon170
Alias: | mid-rr-sys-con-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR7

Instance id: | MID_RR_SYS/CON/MONITOR7
Host: | exflcon147
Alias: | mid-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

###### MONITOR8

Instance id: | MID_RR_SYS/CON/MONITOR8
Host: | exflcon143
Alias: | mid-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/controlServerMonitor
Last modified: | 2019-10-28T10:48:13.000+01:00
Created at: | 2018-11-01T16:30:15.000+01:00
Main authors: | Schaffer, Silenzi
Latest tag: | 1.0.1-2.3.2
Deployment tag: | 1.0.1-2.3.2
Installed tag: | 1.0.1-2.3.2
Scenes: | Global_CPU, Global_MEM
Accessible by: | CONTROLS, DA, scholzma

[add instance documentation]

Release History
1.0.1-2.3.2

Created: | 2019-01-07T09:58:47.000Z
Author: | Robert Schaffer
Notes: | Added __init__ files to solve problem with file structure.

1.0.0-2.2.6

Created: | 2018-12-18T12:20:16.000Z
Author: | Robert Schaffer
Notes: | First implementation of a monitoring device.

##### MDL

###### KARABACON

Instance id: | MID_RR_SYS/MDL/KARABACON
Class id: | Karabacon
Host: | mid-rr-sys-con-gui1
Class documentation:
| Karabacon
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/karaboDevices/Karabacon
Last modified: | 2021-10-04T15:54:23.336+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mamchykd, Hauf, Fabbri
Latest tag: | 2.4.6-2.11.1
Deployment tag: | 2.4.6-2.11.1
Scenes: | MID_RR_SYS/MDL/KARABACON|Plot, MID_RR_SYS/MDL/KARABACON_TEST|Plot, MID_RR_SYS/MDL/KARABACON|Plot, MID_RR_SYS/MDL/KARABACON|MainControl, MID_RR_SYS/MDL/KARABACON|MainControl, MID_RR_SYS/MDL/KARABACON|scene, MID_RR_SYS/MDL/KARABACON|plot, MID_RR_SYS/MDL/KARABACON_ADDON|Main, MID_RR_SYS/MDL/KARABACON|wide, MID_RR_SYS/MDL/KARABACON|norm, MID_RR_SYS/MDL/KARABACON|wide, MID_RR_SYS/MDL/KARABACON|plot, MID_RR_SYS/MDL/KARABACON|scene, MID_SCANTOOL, UserMain, UserSupportingScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- use_daq:
    If the scan should start without XFEL DAQ, set tofalse.
- daqControllerId:
    The deviceId to the daq controller device.
- isConfigured:
    Boolean indicator if the scantool has been configured.
- actualConfiguration:
    String representation of the actual configuration applied for the scan
- activeSources:
    Alias representation of configured data sources
- activeMotors:
    Alias representation of configured motors
- activeTriggers:
    Alias representation of configured triggers
- dataEnv:
    Data Sources
- pipelineWait:
    Set this value to define the pipeline wait time for the data sources to wait for a new value
- pauseEachStep:
    Set to pause on arriving at each motor position
- reset:
    This value is used to reset the plotting
- stream:
    Internal value to signalize streaming while scanning
- isMoving:
    This boolean indicates if the karabacon is in moving state. Required for folding daq data.
- isAcquiring:
    This boolean indicates if the karabacon is acquiringdata. Required for folding daq data.
- acquisitionTime:
    The trigger sources will acquire each step for this period of time. In step scan operation, the Karabacon will wait each step to acquire for this period if configureTriggers is set to True. In continous mode, this value is used to calculate the velocity.
- configureTriggers:
    Set this value to True and the triggers will configure the acquisition time for each step
- configureVelocity:
    Set this value to True to control motor velocity during continuous motion scans. The speed will be calculated from ‘acquisitionTime’.
- availableScenes:
    Provides a scene for the Karabacon. This can be eithera control or plot related scene.
- availableMacros:
    Provides scan macros from the scan device
- output:
    Output Channel for the scan data
- configure:
    Configure the scan environment
- start:
    Start scan with previous applied configuration
- stop:
    Call this slot to stop running scan
- abort:
    Call this slot to stop everything
- pause:
    Call this slot to pause or resume running scan

Release History
2.4.6-2.11.1

Created: | 2021-08-25T16:30:39.000+02:00
Author: | Dennis Goeries
Notes: |

2.4.5-2.11.1

Created: | 2021-07-15T18:00:16.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update

2.4.4-2.11.1

Created: | 2021-07-01T20:52:35.000+02:00
Author: | Steffen Hauf
Notes: | Add MC2 subclasses

2.4.3-2.11.1

Created: | 2021-06-29T00:23:24.000+02:00
Author: | mamchykd
Notes: | Transform functions for motor aNscans, dNscans, mesh and dmesh

2.4.2-2.11.1

Created: | 2021-06-08T17:52:45.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: simulatedTrigger tag updated

2.4.1-2.11.1

Created: | 2021-06-03T08:23:54.000+02:00
Author: | mamchykd
Notes: | Macro async

2.4.0-2.10.0

Created: | 2021-03-22T13:02:09.000+01:00
Author: | Wajid Ehsan
Notes: | Fixed Data source from the output channel value issue

2.3.9-2.10.0

Created: | 2021-02-23T10:06:06.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: Integrate automated alignment extension

2.3.8-2.10.0

Created: | 2021-01-27T19:43:42.000+01:00
Author: | Wajid Ehsan
Notes: | Include JJAttenuator device into scan tool

2.3.7-2.10.0

Created: | 2021-01-13T16:04:37.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.6-2.10.0

Created: | 2020-11-24T22:22:30.000+01:00
Author: | Wajid Ehsan
Notes: | update dependency file

2.3.5-2.10.0

Created: | 2020-11-23T13:18:15.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.5-2.9.1

Created: | 2020-10-16T13:50:26.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Update for new Beckhoff state diagram Installation: No changes. Devices: No change in devices. Schema: No change in schema.

2.3.4-2.9.1

Created: | 2020-09-28T12:18:29.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Smaller fixes for misbehaving triggers, versioning, etc. Installation: No changes to dependencies, no special dependencies Devices: No change in devices. Schema: No change in schema.

2.3.3-2.9.0

Created: | 2020-06-04T17:04:30.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.2-2.8.0

Created: | 2020-05-14T13:24:49.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.8.0

Created: | 2020-04-17T14:19:55.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.7.2

Created: | 2020-03-03T13:10:32.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.8.0

Created: | 2020-03-03T13:00:40.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.6.2-2.6.0

Created: | 2020-02-28T12:16:12.000+01:00
Author: | Wajid Ehsan
Notes: | add Johann Spectrometer class

###### KARABACON_ADDON

Instance id: | MID_RR_SYS/MDL/KARABACON_ADDON
Class id: | ScantoolManipulator
Host: | mid-rr-sys-con-gui1
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/karaboDevices/scantoolManipulator
Last modified: | 2020-11-30T14:52:52.000+01:00
Created at: | 2019-05-24T13:57:07.000+02:00
Main authors: | Fabbri, Schaffer
Latest tag: | 0.2.3-2.10.0
Deployment tag: | 0.2.3-2.10.0
Scenes: | MID_RR_SYS/MDL/KARABACON_ADDON|Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- on:
    Activates the device. If there is an input stream, the device will enter the PROCESSING state.
- off:
    Deactivates the device.
- reset:
    Resets the counter and input values, and the state of the device.
- channelCount:
    Number of outputs of the Karabacon device. Can be reset by reset command.
- externalSources:
    Information related to non-Karabacon sources. One must enter information here for it to be used in the user code.
- karabaconChannel:
    Output channel of the Karabacon scantool device, to be input into this device. The ‘Connected Output Channels’ property should have the format ‘KarabaconDeviceId:output’
- karabaconInput:
    Raw values from the input of the Karabacon scantool.
- codeOutput:
    User provided code to be evaluated. Restrict the code to the variables pos0, pos1, pos2, pos3, y0, y1, y2, y3, y4, y5 and z[i] (defined by Non-Karabacon sources). Also restrict the code to use the functions +,-,/,*,**. or those from the math library (ex. math.log). At least one must be filled.
- output:
    Output Channel for the plots of the user code
- availableScenes:
    Provides a scene for the scan manager

Release History
0.2.3-2.10.0

Created: | 2020-11-30T15:39:43.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add 2.10 versioning

0.2.2-2.6.1

Created: | 2019-09-04T12:22:38.000+02:00
Author: | Robert Schaffer
Notes: | Minor fixes, for demonstration

0.2.1-2.5.0

Created: | 2019-07-23T13:17:06.000+02:00
Author: | Robert Schaffer
Notes: | Beta, MID will bugtest

0.1.1-2.4.0

Created: | 2019-06-07T17:50:21.000+02:00
Author: | Robert Schaffer
Notes: | Prototype version, for demonstration purposes.

###### KARABACON_TEST

Instance id: | MID_RR_SYS/MDL/KARABACON_TEST
Host: | exflcon148
Class documentation:
| Karabacon
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2019-11-04T16:10:03.000+01:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Carinan, Mohacsi
Latest tag: | 1.6.1-2.6.0
Deployment tag: | 1.4.6-2.4.0
Installed tag: | 1.4.6-2.4.0
Scenes: | MID_RR_SYS/MDL/KARABACON_TEST|Plot
Accessible by: | CONTROLS, DA, scholzma

###### SIM_MOTOR

Instance id: | MID_RR_SYS/MDL/SIM_MOTOR
Class id: | SimulatedMotor
Host: | mid-rr-sys-con-gui1
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/karaboDevices/simulatedMotor
Last modified: | 2020-11-27T19:29:27.000+01:00
Created at: | 2019-05-21T10:39:08.000+02:00
Main authors: | Fabbri, Haufs, Schaffer
Latest tag: | 1.0.1-2.10.0
Deployment tag: | 1.0.1-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- interfaces:
    Describes the interfaces for this device
- actualPosition:
    Position of the simulated motor
- targetPosition:
    Target position of the simulated motor
- moveTime:
    Time (in seconds) for the simulated motor to make a single move. This can be adjusted to set the time between adjacent scan points.
- move:
    Moves the simulated motor to the target position, in the time defined by “Move Time”
- stop:
    Stops the simulated motor

Release History
1.0.1-2.10.0

Created: | 2020-11-27T19:29:40.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.0-2.4.0

Created: | 2019-05-29T15:57:08.000+02:00
Author: | Robert Schaffer
Notes: | First version - simple timed simulated motor, compatible with the scantool.

###### TEST_TRIGGER

Instance id: | MID_RR_SYS/MDL/TEST_TRIGGER
Host: | exflcon148
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/simulatedTrigger
Last modified: | 2018-11-21T18:01:13.000+01:00
Created at: | 2017-11-09T17:34:21.000+01:00
Main authors: | Danilevski, Xctrl, Degon
Latest tag: | 1.0.1-2.3.0
Deployment tag: | 1.0.1-2.3.0
Installed tag: | 1.0.1-2.3.0
Accessible by: | CONTROLS, DA, scholzma

Warning

Rogue installation which is not mentioned in the deployment!

###### DAQ_CONTROLLER

Instance id: | MID_RR_SYS/MDL/DAQ_CONTROLLER
Class id: | DaqController
Host: | mid-rr-sys-con-gui1
Alias: | mid-rr-sys-con-gui1
Git repo: | https://git.xfel.eu/karaboDevices/daqController
Last modified: | 2021-07-15T17:12:00.000+02:00
Created at: | 2019-03-11T15:44:30.000+01:00
Main authors: | Mamchykd, Parenti, Haufs
Latest tag: | 1.4.6-2.11.1
Deployment tag: | 1.4.6-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, 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
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- dataAggregators:
    The deviceIds of the DataAggregators retrieved from the current RunController.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.6-2.11.1

Created: | 2021-07-15T17:35:57.000+02:00
Author: | mamchykd
Notes: | Tag from master, contains the fixes related to DaqGlobaState for the Agipd and the Scantool.

1.4.5-2.11.1

Created: | 2021-07-14T20:38:33.000+02:00
Author: | mamchykd
Notes: | A tag from branch, tested with Agipd Dark Proc on Jul 13 2021. To be tested with the Scantools.

1.4.4-2.10.0-hotfix@SPB

Created: | 2021-02-24T17:55:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | For use with JungfrauDarkChar device

1.4.4-2.10.0

Created: | 2020-11-24T22:11:03.000+01:00
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T10:53:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T14:48:22.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T13:27:28.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T16:30:28.000+02:00
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T12:43:24.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T11:20:59.000+02:00
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T13:03:14.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T12:52:23.000+01:00
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T13:19:01.000+02:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T17:29:20.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T11:22:23.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T18:38:41.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T17:45:23.000+02:00
Author: | Dennis Goeries
Notes: |

###### PULSE_PATTERN_DECODER

Instance id: | MID_RR_SYS/MDL/PULSE_PATTERN_DECODER
Class id: | PulsePatternDecoder
Host: | mid-rr-sys-con-11
Alias: | mid-rr-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/pulsePatternDecoder
Last modified: | 2021-09-10T16:40:35.942+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Haufs, Mercadier, Ehsan
Latest tag: | 2.0.5-2.11.0
Deployment tag: | 2.0.5-2.11.0
Scenes: | test, MID_MAIN, UserMain, UsersBeamParameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Pulse Pattern Decoder Documentation

The `Pulse Pattern Decoder` device is documented in pulsepatterndecoder:pulsepatterndecoder

Pulse Pattern Decoder Troubleshooting

To troubleshooting documentation

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
- input:
    Process the data received from the input channel.

Release History
2.0.5-2.11.0

Created: | 2021-07-23T15:24:27.000+02:00
Author: | Alessandro Silenzi
Notes: | no change in schema

2.0.4-2.10.4

Created: | 2021-05-17T19:36:32.000+02:00
Author: | Alessandro Silenzi
Notes: | Added Laser decoding to the PulsePatternDecoder

2.0.3-2.10.0

Created: | 2020-11-24T13:00:46.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.0.2-2.9.6-log-timestamps

Created: | 2020-09-24T14:48:03.000+02:00
Author: | Gabriele Giovanetti
Notes: |

2.0.2-2.9.6

Created: | 2020-09-16T15:50:05.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: prevent unwanted task in karabo 2.9 note: can be used also with other karabo versions

2.0.1-2.9.6

Created: | 2020-09-11T14:56:10.000+02:00
Author: | Gabriele Giovanetti
Notes: | Prevent timestamp jumping backwards

2.0.0-2.9.4-hotfix@SPB

Created: | 2020-09-11T14:11:25.000+02:00
Author: | Gabriele Giovanetti
Notes: | Temporary hotfix: bunchpattern table timestamp propagation leads to wrong data in DAQ

2.0.0-2.9.4

Created: | 2020-08-17T14:53:49.000+02:00
Author: | Steffen Hauf
Notes: | Read the patternTable via an input channel

1.5.0-2.7.0-hotfix

Created: | 2020-07-23T18:04:33.000+02:00
Author: | degon
Notes: | hotfix: fire start slot twice for digitizer

1.5.0-2.7.0

Created: | 2020-03-03T12:36:56.000+01:00
Author: | Wajid Ehsan
Notes: | Integration of new device class which facilitates the integration of Bunch pattern integration into Digitizer

1.4.1-2.6.1

Created: | 2019-11-12T14:57:06.000+01:00
Author: | Denys Mamchyk
Notes: | minor fix for updating the status on error

1.4.0-2.6.1

Created: | 2019-10-04T14:14:33.000+00:00
Author: | Valerii Bondar
Notes: | “Proper” deployment tag from ‘master’ branch. Includes OperationChangeNotifier with no prints.

1.4.0-2.6.1-test

Created: | 2019-10-02T18:48:32.000+02:00
Author: | Valerii Bondar
Notes: | Left by Valerii in his rush to the airport, but we need it now. Print statement must be removed

1.3.2-2.5.0-Notifier

Created: | 2019-09-23T13:53:03.000+02:00
Author: | Valerii Bondar
Notes: | This tag is only for tests of OperationChangeNotifier prototype in MID topic. For production deployment use ‘proper’ tag recommended. This tag should be installed only afterwards (with install_device_active.yml) and decommissioned after tests.

1.3.2-2.5.0

Created: | 2019-08-07T17:00:04.000+02:00
Author: | Denys Mamchyk
Notes: | update for rawDelay calculation

1.3.1-2.5.0

Created: | 2019-08-02T17:21:20.000+02:00
Author: | Wajid Ehsan
Notes: | Set pulse Delay

1.3.0-2.5.0

Created: | 2019-07-30T13:43:21.000+02:00
Author: | Cammille Carinan
Notes: | Integration of bunch pattern setting into fastadc device.

1.2.0-2.3.0

Created: | 2019-03-13T19:08:04.000+01:00
Author: | Alessandro Silenzi
Notes: | Using the euxfel_bunch_pattern package

1.1.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | added MainDump node

1.0.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | Main dump is included in the decoding

###### SCAN_GRID_CREATOR

###### CHANNEL0

###### CHANNEL1

###### CHANNEL2

###### CHANNEL3

###### CHANNEL4

###### CHANNEL5

###### CHANNEL6

###### CHANNEL7

###### CHANNEL8

###### CHANNEL9

##### PIPE

###### AGIPD_RAWGAIN

Instance id: | MID_RR_SYS/PIPE/AGIPD_RAWGAIN
Class id: | TrainMatcher
Host: | exflonc26
Alias: | sa2-br-kc-comp-2 , la2-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2020-11-20T21:03:19.000+01:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 1.0.0-2.7.1
Deployment tag: | 1.0.0-2.7.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘midonc’]!

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
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- output:
    Output channel for combined train data.
- sent:
    Count how many train data were sent.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.

Release History
1.0.0-2.7.1

Created: | 2020-02-18T13:21:57.000Z
Author: | Thomas Michelat
Notes: | Re-implementation: add default scene reconfigurable at run-time: add/remove pipeline connections, add remove fast and slow data) more accurate matching for slow properties train offset for pipeline data show processing info

0.2.1-2.5.0

Created: | 2019-08-27T07:48:16.000Z
Author: | Thomas Michelat
Notes: | add property to allow sending data if input source is missing. add simple implementation of slow data monitor bugfix: handle properly multiple output channel from same device

1.0.0b2-2.4.1

Created: | 2019-05-13T14:44:05.000Z
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T13:40:27.000Z
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T18:50:21.000Z
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T12:01:19.000Z
Author: | Thomas Michelat
Notes: |

###### TRAIN_MATCH_RAW_GAIN

Instance id: | MID_RR_SYS/PIPE/TRAIN_MATCH_RAW_GAIN
Host: | exflonc26
Alias: | sa2-br-kc-comp-2 , la2-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2019-08-27T09:48:18.000+02:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Hauf, Michelat
Latest tag: | 0.2.1-2.5.0
Deployment tag: | 0.2.1-2.5.0
Installed tag: | 0.2.1-2.5.0
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

###### DOOCS_CAM7_TEST

Instance id: | MID_RR_SYS/PIPE/DOOCS_CAM7_TEST
Class id: | TrainMatcher
Host: | exflonc26
Alias: | sa2-br-kc-comp-2 , la2-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2021-06-22T15:27:40.000+02:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Fabbri, Haufs, Schmidt
Latest tag: | 1.2.0-2.10.2
Deployment tag: | 1.2.0-2.10.2
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- mode:
    operation mode, “match”: match all selected fast sources, “buffer”: send (selected) sources that arrived when the buffer reached the limit
- output:
    Output channel for combined train data.
- received:
    Count how many trains were received.
- sent:
    Count how many train data were sent.
- matchingRatio:
    Exponential moving average of the relation between sent and received trains.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.
- delay:
    delay applied before sending data on output channel (in #trains)
- offsetTid:
    If this property is True, it will change the value of the trainId in the metadata for the data sources having an offset value different from 0. The trainId value assigned will be the “matched” trainId, i.e. trainId + offset for the source.

Release History
1.2.0-2.10.2

Created: | 2021-03-26T14:34:34.000Z
Author: | Thomas Michelat
Notes: | Add “buffer” mode

1.1.0-2.10.2

Created: | 2021-03-24T13:37:27.000Z
Author: | Thomas Michelat
Notes: | option to overwrite trainid in metadata if data source is shifted

1.0.1-2.10.0

Created: | 2020-12-02T16:50:00.000Z
Author: | Valerii Bondar
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.0-2.7.1

Created: | 2020-02-18T13:21:57.000Z
Author: | Thomas Michelat
Notes: | Re-implementation: add default scene reconfigurable at run-time: add/remove pipeline connections, add remove fast and slow data) more accurate matching for slow properties train offset for pipeline data show processing info

0.2.1-2.5.0

Created: | 2019-08-27T07:48:16.000Z
Author: | Thomas Michelat
Notes: | add property to allow sending data if input source is missing. add simple implementation of slow data monitor bugfix: handle properly multiple output channel from same device

1.0.0b2-2.4.1

Created: | 2019-05-13T14:44:05.000Z
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T13:40:27.000Z
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T18:50:21.000Z
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T12:01:19.000Z
Author: | Thomas Michelat
Notes: |

##### PLC

###### 1

Instance id: | MID_RR_SYS/PLC/1
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Projects: | MID_RR_SYS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 10

Instance id: | MID_RR_SYS/PLC/10
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-3
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 10_PLCMON

Instance id: | MID_RR_SYS/PLC/10_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 11

Instance id: | MID_RR_SYS/PLC/11
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 11_PLCMON

Instance id: | MID_RR_SYS/PLC/11_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-4
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 12

Instance id: | MID_RR_SYS/PLC/12
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-10
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-10
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 12_PLCMON

Instance id: | MID_RR_SYS/PLC/12_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-10
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-10
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 3

Instance id: | MID_RR_SYS/PLC/3
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 3_PLCMON

Instance id: | MID_RR_SYS/PLC/3_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### 4

Instance id: | MID_RR_SYS/PLC/4
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 4_PLCMON

Instance id: | MID_RR_SYS/PLC/4_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-12 , mid-rr-sys-con-10 , mid-rr-sys-con-11 , mid-rr-sys-con-13 , mid-rr-sys-con-1 , mid-rr-sys-con-14 , mid-rr-sys-con-15
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.8.1-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.8.1-2.11.4) 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

###### 5

Instance id: | MID_RR_SYS/PLC/5
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-3
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 5_PLCMON

Instance id: | MID_RR_SYS/PLC/5_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-3
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-3
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 6

Instance id: | MID_RR_SYS/PLC/6
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 6_PLCMON

Instance id: | MID_RR_SYS/PLC/6_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 7

Instance id: | MID_RR_SYS/PLC/7
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 7_PLCMON

Instance id: | MID_RR_SYS/PLC/7_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 8

Instance id: | MID_RR_SYS/PLC/8
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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

###### 8_PLCMON

Instance id: | MID_RR_SYS/PLC/8_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | mid-rr-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-2
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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

###### 9

Instance id: | MID_RR_SYS/PLC/9
Class id: | BeckhoffCom
Host: | mid-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | mid-rr-sys-con-4
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.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, scholzma, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-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
- 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
- reset:
    Resets the Karabo device in case of an error
- 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.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

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