# HED

## HI

### OM

#### 01

##### HOR

##### VER

#### 03

##### HOR

##### VER

#### 04

##### HOR

##### VER

#### 05

##### HOR

##### VER

#### 06

##### HOR

##### VER

#### 07

##### HOR

##### VER

#### 08

##### HOR

##### VER

#### 09

##### HOR

##### VER

#### 10

##### HOR

##### VER

#### 02

[add component documentation]

##### HOR

[add component documentation]

###### Spare

##### VER

[add component documentation]

###### Spare

### PICO

#### 1

##### HOR

##### VER

## controller

[add component documentation]

### HIT

### HED

[add component documentation]

#### EXP

[add component documentation]

##### HIDIG

## XFEL

[add component documentation]

### SDIAG

[add component documentation]

#### BAM

[add component documentation]

##### DOOCS

[add component documentation]

###### 1932M_TL

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### 1932S_TL

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### 414_B2

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

## MID

[add component documentation]

### LAS

[add component documentation]

#### COM

[add component documentation]

##### MOTOR

[add component documentation]

###### MIRR1_1

###### MIRR1_2

###### MIRR2_1

###### MIRR2_2

## SA2

### CTRL

#### NBUNCH

##### DOOCS

###### XRAY_POD

Instance id: | SA2_CTRL_NBUNCH/DOOCS/XRAY_POD
Class id: | DoocsPulseKicker
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | flyscan, HED_RR_SYS/MDL/BASEBACON|MainControl, HED_RR_SYS/PROC/CINEBACON|cockpit, HED_IA1_DETM/MOTOR/AXIS_08_SAM_X
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.13-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: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A3

Instance id: | SA2_XTD1_ATT/PNACT/A3
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A4

Instance id: | SA2_XTD1_ATT/PNACT/A4
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A5

Instance id: | SA2_XTD1_ATT/PNACT/A5
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A6

Instance id: | SA2_XTD1_ATT/PNACT/A6
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A7

Instance id: | SA2_XTD1_ATT/PNACT/A7
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A8

Instance id: | SA2_XTD1_ATT/PNACT/A8
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.
- 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

###### A9

Instance id: | SA2_XTD1_ATT/PNACT/A9
Host: | exflcon180
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-7 , hed-rr-sys-con-stage
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.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

Might be hot-fixed, dt=67 days, 7:58:00!

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

##### MDL

[add component documentation]

###### MAIN

#### CRL

##### MOTOR

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

###### LENS10_X

###### LENS10_Y

###### LENS1_X

###### LENS1_Y

###### LENS2_X

###### LENS2_Y

###### LENS3_X

###### LENS3_Y

###### LENS4_X

###### LENS4_Y

###### LENS5_X

###### LENS5_Y

###### LENS6_X

###### LENS6_Y

###### LENS7_X

###### LENS7_Y

###### LENS8_X

###### LENS8_Y

###### LENS9_X

###### LENS9_Y

###### CHAM_AX

#### IMGFEL

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | hed-rr-sys-con-15
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-15
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-15
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, 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

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

#### IMGSR

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGSR/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | hed-rr-sys-con-15
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGSR/CAM/BEAMVIEW
Class id: | PhotonicScienceCamera
Host: | hed-rr-sys-con-15
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

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

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

#### XGM

###### DOOCS

Instance id: | SA2_XTD1_XGM/XGM/DOOCS
Class id: | DoocsXGM
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | SA2_XTD1_XGM_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

#### DOOCS

[add component documentation]

##### BAM

[add component documentation]

###### LCAT1932M_TL

###### LCAT1932S_TL

###### LCAT414_B2

### XTD6

#### IMGPII45-1

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | hed-rr-sys-con-15
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-15
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-15
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, 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

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

#### IMGPII45-2

##### PROC

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | hed-rr-sys-con-15
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-15
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-15
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, 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

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

#### MIRR-1

##### MOTOR

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

#### MIRR-2

##### MOTOR

###### BENDER

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

#### MIRR-3

##### MOTOR

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

#### VAC

[add component documentation]

##### VSWITCH

[add component documentation]

###### P22450I_ON_SP

Instance id: | SA2_XTD6_VAC/VSWITCH/P22450I_ON_SP
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### V22440M_OPEN

Instance id: | SA2_XTD6_VAC/VSWITCH/V22440M_OPEN
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HIREX

[add component documentation]

##### AVG

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/AVG/BRAGG
Class id: | ImageAverager
Host: | hed-rr-sys-con-15
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-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.
- 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.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

##### CAM

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/CAM/BRAGG
Class id: | PhotonicScienceCamera
Host: | hed-rr-sys-con-15
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-15
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

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

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### DETECTOR

Instance id: | SA2_XTD6_HIREX/CAM/DETECTOR
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-15
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-15
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, 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

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

##### DAQ

[add component documentation]

###### GOTTHARD_MASTER

Instance id: | SA2_XTD6_HIREX/DAQ/GOTTHARD_MASTER
Class id: | GotthardReceiver
Host: | hed-rr-sys-con-15
Class documentation:
| GotthardReceiver
Alias: | hed-rr-sys-con-15
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, 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: | hed-rr-sys-con-15
Class documentation:
| GotthardControl
Alias: | hed-rr-sys-con-15
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, 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

##### MDL

[add component documentation]

###### FEL_SPECTROMETER

##### MOTOR

[add component documentation]

###### CRYSTALUNIT_X

###### CRYSTALUNIT_Y

###### CRYSTAL_RX

###### CRYSTAL_X

###### DETECTOR_RX

###### DETECTOR_X

##### PROC

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/PROC/BRAGG
Class id: | ImageProcessor
Host: | hed-rr-sys-con-15
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### BR

[add component documentation]

#### UTC

[add component documentation]

##### MDL

[add component documentation]

###### BUNCHPATTERN_DECODER

Instance id: | SA2_BR_UTC/MDL/BUNCHPATTERN_DECODER
Class id: | PulsePatternDecoder
Host: | hed-rr-sys-con-15
Alias: | hed-rr-sys-con-15
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: | HED_HPLAS_HIL/RelaxTiming
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

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

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

### SRP

[add component documentation]

#### AIBS

[add component documentation]

##### AIBS

[add component documentation]

###### HED_AIBS

## TILT

[add component documentation]

### 1

### 10

### 11

### 12

### 13

### 4

### 5

### 7

### 9

## TIP

[add component documentation]

### 1

### 10

### 11

### 12

### 13

### 4

### 5

### 7

### 9

## HZDR

[add component documentation]

### Controller

[add component documentation]

#### IC2

## LAS

[add component documentation]

### PPL

[add component documentation]

#### SA2XT

[add component documentation]

##### DCTRL

[add component documentation]

###### 5V_OUTPUT_2

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-15
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | COMP_SHOT_ON_DEMAND/PPLaser, APP2656/rasterScan
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

## LA2

[add component documentation]

### LAS

[add component documentation]

#### PPL

[add component documentation]

##### CTRL

[add component documentation]

###### TRGDLY

## LASER1

[add component documentation]

### PULS

[add component documentation]

#### TRIGGER

Instance id: | LASER1_PULS_TRIGGER
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

## UP

[add component documentation]

### DIC

[add component documentation]

#### TILT

#### YAW

### MIR

[add component documentation]

#### ROT

#### TILT

#### YAW

## hed

### exp

#### ibs

##### cam

Instance id: | hed_exp_ibs_cam_cam
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_exp_ibs_cam_cam|scene, HED_BS_DIODE, APP_HED_EXP_MAIN/Shutdown, COMP_HED_IBS/CrossHair
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### proc

###### cam

Instance id: | hed_exp_ibs_proc_cam
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | COMP_HED_IBS/IMG_PROC
Accessible by: |

Warning

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

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.

##### avg

###### cam

Instance id: | hed_exp_ibs_avg_cam
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | hed_exp_ibs_avg_cam
Accessible by: |

Warning

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

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.

### ia1

#### telescope

##### 1

###### ave

Instance id: | hed_ia1_telescope_1_ave
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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
Scenes: | hed_ia1_telescope_1_cam_cam|scene, HED_IA1_FSSS_MAIN
Accessible by: | CONTROLS, DA

[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

###### cam

cam

Instance id: | hed_ia1_telescope_1_cam_cam
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | hed_ia1_telescope_1_cam_cam|scene, hed_ia1_telescopes_cam_cam|scene0, HED_IA1_FSSS_MAIN, hed_ia1_telescope_1_cam_cam|scene, complete, hed_ia1_telescope_2_cam_cam|scene0
Accessible by: | CONTROLS, DA

[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

###### proc

Instance id: | hed_ia1_telescope_1_proc
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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
Scenes: | hed_ia1_telescope_1_cam_cam|scene
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

Release History
1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

##### 2

###### cam

cam

Instance id: | hed_ia1_telescope_2_cam_cam
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | hed_ia1_telescopes_cam_cam|scene0, hed_ia1_telescope_2_cam_cam|scene, hed_ia1_telescope_2_cam_cam|scene, complete, hed_ia1_telescope_2_cam_cam|scene0
Accessible by: | CONTROLS, DA

[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

## karabo

[add component documentation]

### SA2interlockMonitor

Instance id: | karabo/SA2interlockMonitor
Class id: | InterlockMonitor
Host: | hed-rr-sys-con-2
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/interlockMonitor
Last modified: | 2021-05-25T12:52:43.000+02:00
Created at: | 2018-10-10T10:28:32.000+02:00
Main authors: | Parenti, Hauf, Silenzi
Latest tag: | 0.2.4-2.11.0
Deployment tag: | 0.2.4-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

#### Release History

##### 0.2.4-2.11.0

Created: | 2021-05-25T11:57:13.000+02:00
Author: | Alessandro Silenzi
Notes: | use async await syntax

##### 0.2.3-2.10.0

Created: | 2020-12-02T08:56:09.000+01:00
Author: | Alessandro Silenzi
Notes: | FIX: do not fail on UNKNOWN inputs

##### 0.2.2-2.10.0

Created: | 2020-11-26T13:55:58.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

##### 0.2.1-2.9.0

Created: | 2020-08-26T11:42:38.000+02:00
Author: | Alessandro Silenzi
Notes: | Hotfix following definitions: The Shutter enable Logic should evaluate the absorber not the beam OK signal Installation: this package will run in a custom server called karabo-interlockwatchdogserver . Release tests shall be defined. Devices: No devices can be instantiated from that server. It has a custom static configuration.

##### 0.2.0-2.9.0

Created: | 2020-08-14T18:10:58.000+02:00
Author: | Alessandro Silenzi
Notes: | Tag implementing 17.07.2020 definitions Installation: this package will run in a custom server called karabo-interlockwatchdogserver . Release tests shall be defined. Devices: No devices can be instantiated from that server. It has a custom static configuration.

##### 0.1.1-2.3.0

Created: | 2019-03-05T13:56:04.000+01:00
Author: | Alessandro Silenzi
Notes: | corrected shutter condition

##### 0.1.0-2.3.0

Created: | 2019-03-01T16:23:29.000+01:00
Author: | Alessandro Silenzi
Notes: | Including B4C beamstop

##### 0.0.1-2.3.0

Created: | 2018-12-13T13:32:23.000+01:00
Author: | Alessandro Silenzi
Notes: |

##### 0.0.0-2.3.0

Created: | 2018-12-12T10:36:11.000+01:00
Author: | Valerii Bondar
Notes: |

## HED

### DAQ_Controller

### EXP

#### HAM_STREAK_CAMERA

Instance id: | HED/EXP/HAM_STREAK_CAMERA
Class id: | HamamatsuStreakCamera
Host: | hed-rr-sys-con-15
Alias: | hed-rr-sys-con-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/hamamatsuStreakCamera
Last modified: | 2021-06-08T16:55:01.000+02:00
Created at: | 2019-06-25T11:52:38.000+02:00
Main authors: | Parenti, Fabbri, Haufs
Latest tag: | 1.1.4-2.11.1
Deployment tag: | 1.1.4-2.11.1
Scenes: | Streak_camera, STREAK_CAMERA
Accessible by: | CONTROLS, CTRL, DA, danilevc, 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
- connect:
    Connect to the RemoteEx application.
- acquire:
    Instruct camera to start acquisition.
- stop:
    Instruct camera to stop current acquisition.
- reset:
    Reset software error.
- frameRate:
    The camera frame rate.
- imgDelay:
    The difference between image reception time and its timestamp on RemoteEx.
- cameraIp:
    The name of the host where the RemoteEx application is running.
- remoteExDate:
    RemoteEx application date.
- remoteExVersion:
    RemoteEx application version.

##### Release History

###### 1.1.4-2.11.1

Created: | 2021-06-08T14:54:47.000Z
Author: | mamchykd
Notes: | dependencies updated

###### 1.1.3-2.10.2

Created: | 2021-02-25T12:58:34.000Z
Author: | Andrea Parenti
Notes: | Summary: * add exposure parameter; * fix connection function (for large images); * fix frame rate calculation for exposure > 1 s; * only update frame rate and image delay during acquisition.

###### 1.1.3rc1-2.10.2

Created: | 2021-02-24T14:51:39.000Z
Author: | Andrea Parenti
Notes: | Summary: * add exposure parameter; * fix connection function (for large images); * fix frame rate calculation for exposure > 1 s; * only update frame rate and image delay during acquisition.

###### 1.1.2-2.10.0

Created: | 2020-12-02T18:08:22.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

###### 1.1.1-2.9.8

Created: | 2020-10-28T17:02:25.000Z
Author: | Andrea Parenti
Notes: | Summary: Update imageSourcePy to 1.1.3-2.9.1

###### 1.1.0-2.9.8

Created: | 2020-10-28T15:26:34.000Z
Author: | Andrea Parenti
Notes: | Summary: * FIX inject options on connection * ADD timingMode property Schema: add new property “timingMode”

###### 1.0.2-2.8.1

Created: | 2020-03-27T16:10:04.000Z
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

###### 1.0.1-2.8.0

Created: | 2020-03-19T10:48:30.000Z
Author: | Andrea Parenti
Notes: | Make use of ImageSourcePy library

###### 1.0.0-2.6.2

Created: | 2019-10-02T08:04:56.000Z
Author: | Andrea Parenti
Notes: | First release

###### 0.1-2.5.1

Created: | 2019-08-15T13:55:49.000Z
Author: | Andrea Parenti
Notes: | First version

#### BIAS

##### CTRL

###### CONFIG_CONTROL

##### DCTRL

###### HV_ILOCK_01

Instance id: | HED_EXP_BIAS/DCTRL/HV_ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | EPIX100-1_POWER, EPIX10K-3_POWER, EPIX100-3_POWER, EPIX10K-2_POWER, EPIX100-2_POWER, JF_MAIN, EPIX_MAIN, EP2, EP3, JF_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HV_ILOCK_02

Instance id: | HED_EXP_BIAS/DCTRL/HV_ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/HV_ILOCK_02|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HV_ILOCK_03

Instance id: | HED_EXP_BIAS/DCTRL/HV_ILOCK_03
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HV_ILOCK_04

Instance id: | HED_EXP_BIAS/DCTRL/HV_ILOCK_04
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_01

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | EPIX100-1_POWER, EPIX100-2_POWER, HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview, EPIX_MAIN, EP2, EP3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_02

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | EPIX100-3_POWER, EPIX10K-2_POWER, HED_EXP_BIAS/DCTRL/LV_ILOCK_02|scene, EPIX_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_03

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_03
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | EPIX10K-3_POWER, HED_EXP_BIAS/DCTRL/LV_ILOCK_03|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_04

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_04
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_05

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_05
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | JUNGFRAU_POWER, HED_EXP_BIAS/DCTRL/LV_ILOCK_05|scene, JF_MAIN, ch201, Masterview, JF_MAIN, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_06

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_06
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | JUNGFRAU_POWER, HED_EXP_BIAS/DCTRL/LV_ILOCK_06|scene, HED_EXP_BIAS/DCTRL/LV_ILOCK_06|scene, JF_MAIN, EPIX_MAIN, ch201, EP2, EP3, JF_MAIN, CHILL1_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_07

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_07
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_08

Instance id: | HED_EXP_BIAS/DCTRL/LV_ILOCK_08
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_EXP_BIAS/MCPS/DETLVHV
Class id: | Mpod
Host: | hed-rr-sys-con-3
Class documentation:
| Mpod
Alias: | hed-rr-sys-con-3
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: | JUNGFRAU_POWER, EPIX100-1_POWER, EPIX10K-3_POWER, EPIX100-3_POWER, EPIX10K-2_POWER, HED_EXP_BIAS/MCPS/DETLVHV|overview, Diode, EPIX10K-1_POWER, EPIX10K-2_POWER, EPIX10K-3_POWER, JUNGFRAU_POWER, JUNGFRAU_POWER0, Diode, HED_EXP_BIAS/MCPS/DETLVHV|overview, EPIX100-2_POWER, HED_EXP_BIAS/MCPS/DETLVHV|overview, EPIX100-1_POWER, EPIX100-2_POWER, JUNGFRAU_POWER, MPOD_DEVICES, ALL_DET_CTRL_old, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL, ALL_DET_CTRL_2716, JF_MAIN, EPIX_MAIN, ch201, EP2, EP3, IPM_PDs, IPM_APDs, JF_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### CHILL1

##### ASENS

###### IA1_FM01

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | EPIX100-1_INTERLOCK, EPIX100-2_INTERLOCK, HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM02

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM03

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM04

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM05

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM05
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM06

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM06
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM07

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM07
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM08

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM08
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM09

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM09
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM10

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM10
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM11

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM11
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IA1_FM12

Instance id: | HED_EXP_CHILL1/ASENS/IA1_FM12
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PS_IN

Instance id: | HED_EXP_CHILL1/ASENS/PS_IN
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PS_OUT

Instance id: | HED_EXP_CHILL1/ASENS/PS_OUT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_EXP_CHILL1/CHILL/CTRL
Class id: | BeckhoffChiller
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | JF_MAIN, EPIX_MAIN, CHILL1_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TSENS

###### TS_IN

Instance id: | HED_EXP_CHILL1/TSENS/TS_IN
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_OUT

Instance id: | HED_EXP_CHILL1/TSENS/TS_OUT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### FDI

##### AVE

###### CAM_3

Instance id: | HED_EXP_FDI/AVE/CAM_3
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | cam3, PAM-Spatial-MAIN, PAM-Spatial-NEW_3, PAM-Spatial-MAIN, PAM-Spatial-MAIN
Accessible by: |

Warning

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

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_4

Instance id: | HED_EXP_FDI/AVE/CAM_4
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | cam4, TMP
Accessible by: |

Warning

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

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.

##### BGS

###### CAM_3

Instance id: | HED_EXP_FDI/BGS/CAM_3
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | cam3, PAM-Spatial-MAIN, PAM-Spatial-NEW_3, HED_OPT_PAM/MAIN, HED_OPT_PAM/MAIN, PAM-Spatial-MAIN, PAM-Spatial-MAIN
Accessible by: |

Warning

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

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.

###### CAM_4

Instance id: | HED_EXP_FDI/BGS/CAM_4
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | cam4
Accessible by: |

Warning

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

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.

##### CAM

###### CAM_1

Instance id: | HED_EXP_FDI/CAM/CAM_1
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | PAM-Spatial, HED_EXP_FDI/CAM/CAM_1|scene, PAM-Spectral
Accessible by: | CONTROLS, DA

[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

###### CAM_2

Instance id: | HED_EXP_FDI/CAM/CAM_2
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | HED_EXP_FDI/CAM/CAM_2|scene
Accessible by: | CONTROLS, DA

[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

###### 3

Instance id: | HED_EXP_FDI_CAM_3
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers, HED_IA1_FSI/Illumination, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/HED_ILLUMINATION
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### 4

Instance id: | HED_EXP_FDI_CAM_4
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers, HED_IA1_FSI/Illumination, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/HED_ILLUMINATION
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### CAM_3

Instance id: | HED_EXP_FDI/CAM/CAM_3
Class id: | PhotonicScienceCamera
Host: | hed-rr-sys-con-11
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2020-11-24T11:28:59.000+01:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Installed tag: | 3.11.7-2.10.0
Scenes: | cam3, all_camera_temp, HED_EXP_FDI/CAM/CAM_3|scene, PAM-Spatial-MAIN, PAM-Spatial-NEW_3, test_img_diff, PAM-Spatial-MAIN, PAM-Spatial-MAIN, PAM_Spatial_CAM_alignment, Spatial_CAM_Alignment
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Might be hot-fixed, dt=161 days, 8:12:00!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T10:38:08.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T09:47:57.000Z
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### CAM_4

Instance id: | HED_EXP_FDI/CAM/CAM_4
Class id: | PhotonicScienceCamera
Host: | exflcon165
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2020-11-24T11:28:59.000+01:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Scenes: | HED_EXP_FDI/CAM/CAM_4|scene, cam4
Accessible by: |

Warning

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

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T10:38:08.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T09:47:57.000Z
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### ACA1920-1

Instance id: | HED_EXP_FDI/CAM/ACA1920-1
Class id: | LimaBaslerCamera
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-08-17T15:02:10.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Goeries
Latest tag: | 5.6.8-2.9.1
Deployment tag: | 5.6.8-2.9.1
Accessible by: |

Warning

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

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

5.5.3-2.3.5

Created: | 2019-03-06T13:25:32.000Z
Author: | Andrea Parenti
Notes: | Do not block the newImage callback

###### ACA1920-2

Instance id: | HED_EXP_FDI/CAM/ACA1920-2
Class id: | LimaBaslerCamera
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
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: | HED_EXP_FDI/CAM/ACA1920-2|scene
Accessible by: |

Warning

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

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

###### CAM_3

Instance id: | HED_EXP_FDI/PROC/CAM_3
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | cam3, PAM-Spatial-MAIN, PAM-Spatial-NEW_3, HED_OPT_PAM/MAIN, HED_OPT_PAM/MAIN, PAM-Spatial-MAIN, PAM-Spatial-MAIN
Accessible by: |

Warning

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

Image Processor

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

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

1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### CAM_4

Instance id: | HED_EXP_FDI/PROC/CAM_4
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | cam4, TMP
Accessible by: |

Warning

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

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.

##### DCTRL

[add component documentation]

###### SHUT_COIL

Instance id: | HED_EXP_FDI/DCTRL/SHUT_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### DELAY_HI_1

###### DELAY_HI_2

###### MIRR1_H

###### MIRR1_V

###### MIRR2_H

###### MIRR2_V

##### SWITCH

[add component documentation]

###### SHUT_LO

Instance id: | HED_EXP_FDI/SWITCH/SHUT_LO
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HIDG

##### ACORR

###### CAM3

Instance id: | HED_EXP_HIDG/ACORR/CAM3
Class id: | AutoCorrelator
Host: | hed-rr-sys-con-21
Alias: | hed-rr-sys-con-21
Git repo: | https://git.xfel.eu/karaboDevices/autoCorrelator
Last modified: | 2021-08-03T17:04:22.000+02:00
Created at: | 2017-01-18T17:29:30.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 2.3.7-2.11.1
Deployment tag: | 2.3.7-2.11.1
Scenes: | BCC_CAM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Auto Correlator

The `AutoCorrelator` device is documented in autoCorrelator: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, 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
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- delay:
    Delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calculate calibration constant from two input images.
- reset:
    Acknowledge error.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.

Release History
2.3.7-2.11.1

Created: | 2021-08-03T17:05:54.000+02:00
Author: | Andrea Parenti
Notes: | Summary: update imageProcessing to 2.5.0-2.11.1.

2.3.6-2.10.0

Created: | 2020-12-01T11:01:48.000+01:00
Author: | Gabriele Giovanetti
Notes: | updated dependencies

2.3.5-2.9.8

Created: | 2020-11-19T11:09:16.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

2.3.5-2.10.0

Created: | 2020-11-19T11:09:16.000+01:00
Author: | Andrea Parenti
Notes: | Same as 2.3.5-2.9.8

2.3.4-2.7.2

Created: | 2020-03-03T13:06:01.000+01:00
Author: | Andrea Parenti
Notes: | Update test platforms + DEPENDS

2.3.3-2.7.0

Created: | 2019-12-20T16:22:43.000+01:00
Author: | Riccardo Fabbri
Notes: | Added initial documentation

2.3.2-2.7.0

Created: | 2019-12-20T15:37:18.000+01:00
Author: | Riccardo Fabbri
Notes: | Added option for pedestal subtraction

2.3.1-2.7.0

Created: | 2019-12-20T11:37:04.000+01:00
Author: | Riccardo Fabbri
Notes: | Bug/Fix corrected in the FWHM extraction

2.3.0-2.7.0

Created: | 2019-12-19T12:46:35.000+01:00
Author: | Andrea Parenti
Notes: | Use NoFSM Code refactoring

2.2.4-2.6.1

Created: | 2019-12-17T13:59:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Added to output channel the visualization of fit results

2.2.3-2.4.0

Created: | 2019-03-28T16:16:38.000+01:00
Author: | Riccardo Fabbri
Notes: | dependency on imageProcessing updated

2.2.2-2.2.1

Created: | 2018-01-26T15:45:55.000+01:00
Author: | Gabriele Giovanetti
Notes: |

2.2.1-2.2.1

Created: | 2018-01-18T12:07:56.000+01:00
Author: | Gabriele Giovanetti
Notes: | updated DEPENDS to latest imageProcessing tag

2.2.0-2.1

Created: | 2017-08-04T12:16:35.000+02:00
Author: | Andrea Parenti
Notes: | Add shape factor for gaussian and sech^2 beam shape.

2.1.0-2.1

Created: | 2017-07-25T11:22:20.000+02:00
Author: | Andrea Parenti
Notes: | DAQ compatible

2.0.0-2.1

Created: | 2017-03-24T14:00:48.000+01:00
Author: | Andrea Parenti
Notes: | Tag for WP78 installation

1.2.0-1.4

Created: | 2016-07-22T09:33:13.000+00:00
Author: | Andrea Parenti
Notes: | Package autoCorrelator got tagged from “branches/1.2-1.4” to “tags/1.2.0-1.4” via karabo script

1.0.0-1.1

Created: | 2014-09-18T09:29:41.000+00:00
Author: | Majank Kumar
Notes: | creating tags/1.0.0-1.1

1.0.0

Created: | 2014-05-21T08:45:03.000+00:00
Author: | Majank Kumar
Notes: | creating tagged release 1.0.0

##### ASENS

###### DAQ3

Instance id: | HED_EXP_HIDG/ASENS/DAQ3
Class id: | GentecMAESTRO
Host: | exflcon191
Alias: | hed-rr-sys-con-22
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/GentecMAESTRO
Last modified: | 2020-04-17T13:32:43.000+02:00
Created at: | 2018-09-18T09:34:47.000+02:00
Main authors: | 3309
Latest tag: | 1.0.1-2.7.0
Deployment tag: | 1.0.1-2.7.0
Scenes: | GentecMaestro, GentecMaestro, Maestro, HED_HPLAS_HIL/Shot_scene
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- ipAddress:
    IP address of GentecIO Maestro
- portNumber:
    Port number of MAESTRO
- versionInfo:
    Version of device
- autoScale:
    Auto scale mode status
- connect:
    Connect to device
- toggleAutoScale:
    Set scale to automatic mode
- startAcquisition:
    Start acquisition
- stopAcquisition:
    Stop acquisition
- setZero:
    Set new zero offset
- clearZero:
    Clear zero offset
- currentScale:
    Current scale
- currentWavelength:
    Current wavelength
- readoutDelay:
    Delay between to data readouts
- userOffset:
    User offset value
- userMultiplier:
    User multiplier value
- attenuatorAvailable:
    Is an attenuator available
- attenuatorStatus:
    Is attenuator enabled
- sensorName:
    Name of sensor
- sensorSerial:
    Serial number of sensor

Release History
1.0.1-2.7.0

Created: | 2019-05-29T12:09:59.000Z
Author: | Dreyer, Dr. Joern (FWKH) - 3309
Notes: |

1.0.0-2.4.0

Created: | 2019-05-29T12:09:59.000Z
Author: | Dreyer, Dr. Joern (FWKH) - 3309
Notes: |

##### CAM

###### CAM1

Instance id: | HED_EXP_HIDG/CAM/CAM1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM1|scene, HED_EXP_HIDG/CAM/CAM10|scene, HED_EXP_HIDG/CAM/CAM11|scene, HED_EXP_HIDG/CAM/CAM12|scene, HED_EXP_HIDG/CAM/CAM13|scene, HED_EXP_HIDG/CAM/CAM14|scene, HED_EXP_HIDG/CAM/CAM15|scene, HED_EXP_HIDG/CAM/CAM16|scene, HED_EXP_HIDG/CAM/CAM17|scene, HED_EXP_HIDG/CAM/CAM18|scene, HED_EXP_HIDG/CAM/CAM19|scene, Main_Diag_Cam, HED_IA1_FSI_MAIN, HED_IA1_LASER_ALIGNMENT, BCC_CAM, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, test_HIDG1_HIDG2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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.

###### CAM10

Instance id: | HED_EXP_HIDG/CAM/CAM10
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM10|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM11

Instance id: | HED_EXP_HIDG/CAM/CAM11
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM11|scene, Main_Diag_Cam, BCC_CAM, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM12

Instance id: | HED_EXP_HIDG/CAM/CAM12
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM12|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM13

Instance id: | HED_EXP_HIDG/CAM/CAM13
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM13|scene, HED_IA1_FSI_MAIN, HED_IA1_LASER_ALIGNMENT, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM14

Instance id: | HED_EXP_HIDG/CAM/CAM14
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM14|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM15

Instance id: | HED_EXP_HIDG/CAM/CAM15
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM15|scene, Main_Diag_Cam, BCC_CAM, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM16

Instance id: | HED_EXP_HIDG/CAM/CAM16
Class id: | LimaBaslerCamera
Host: | exflcon181
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM16|scene
Accessible by: |

Warning

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

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

###### CAM17

Instance id: | HED_EXP_HIDG/CAM/CAM17
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM17|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM18

Instance id: | HED_EXP_HIDG/CAM/CAM18
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM18|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM19

Instance id: | HED_EXP_HIDG/CAM/CAM19
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, NEW, HED_EXP_HIDG/CAM/CAM19|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM2

Instance id: | HED_EXP_HIDG/CAM/CAM2
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | main_A23, CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM2|scene, HED_EXP_HIDG/CAM/CAM20|scene, HED_EXP_HIDG/CAM/CAM21|scene, HED_EXP_HIDG/CAM/CAM22|scene, HED_EXP_HIDG/CAM/CAM23|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown, test_HIDG1_HIDG2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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.6.10-2.11.1

Created: | 2021-06-11T10:14:55.000Z
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-09T09:54:35.000Z
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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.6.10-2.11.1

Created: | 2021-06-11T10:14:55.000Z
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-09T09:54:35.000Z
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### CAM20

Instance id: | HED_EXP_HIDG/CAM/CAM20
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | main_A23, CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM20|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM21

Instance id: | HED_EXP_HIDG/CAM/CAM21
Host: | exflcon181
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM21|scene
Accessible by: | CONTROLS, DA

[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

###### CAM22

Instance id: | HED_EXP_HIDG/CAM/CAM22
Class id: | LimaBaslerCamera
Host: | exflcon164
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-17
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM22|scene
Accessible by: |

Warning

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

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

###### CAM23

Instance id: | HED_EXP_HIDG/CAM/CAM23
Class id: | LimaBaslerCamera
Host: | exflcon164
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-17
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM23|scene
Accessible by: |

Warning

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

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: | HED_EXP_HIDG/CAM/CAM3
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM3|scene, Main_Diag_Cam, BCC_CAM, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM4

Instance id: | HED_EXP_HIDG/CAM/CAM4
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM4|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Might be hot-fixed, dt=140 days, 16:46:00!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### CAM5

Instance id: | HED_EXP_HIDG/CAM/CAM5
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM5|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM6

Instance id: | HED_EXP_HIDG/CAM/CAM6
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM6|scene, Main_Diag_Cam, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM7

Instance id: | HED_EXP_HIDG/CAM/CAM7
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | test, main_A23, HED_LAS_COM/CAM/PAM_FF2Scene, CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM7|scene, Main_Diag_Cam, PAM_CAM, BCC_CAM, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM8

Instance id: | HED_EXP_HIDG/CAM/CAM8
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | test, CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM8|scene, Main_Diag_Cam, PAM_CAM, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM9

Instance id: | HED_EXP_HIDG/CAM/CAM9
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-21
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-21
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: | CAMS_STATE_OVERVIEW, HED_EXP_HIDG/CAM/CAM9|scene, Main_Diag_Cam, PAM_CAM, BCC_CAM, APP_HED_EXP_MAIN/Shutdown, PAM-PROBE, PAM-PROBE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### PROC

###### CAM1

Instance id: | HED_EXP_HIDG/PROC/CAM1
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM1|scene, HED_EXP_HIDG/CAM/CAM10|scene, HED_EXP_HIDG/CAM/CAM11|scene, HED_EXP_HIDG/CAM/CAM12|scene, HED_EXP_HIDG/CAM/CAM14|scene, HED_EXP_HIDG/CAM/CAM15|scene, HED_EXP_HIDG/CAM/CAM17|scene, HED_EXP_HIDG/CAM/CAM18|scene, HED_EXP_HIDG/CAM/CAM19|scene
Accessible by: |

Warning

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

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.

###### CAM10

Instance id: | HED_EXP_HIDG/PROC/CAM10
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM10|scene
Accessible by: |

Warning

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

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.

###### CAM11

Instance id: | HED_EXP_HIDG/PROC/CAM11
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM11|scene
Accessible by: |

Warning

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

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.

###### CAM12

Instance id: | HED_EXP_HIDG/PROC/CAM12
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM12|scene
Accessible by: |

Warning

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

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.

###### CAM13

Instance id: | HED_EXP_HIDG/PROC/CAM13
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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’, ‘hedonc’]!

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.

###### CAM14

Instance id: | HED_EXP_HIDG/PROC/CAM14
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM14|scene
Accessible by: |

Warning

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

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.

###### CAM15

Instance id: | HED_EXP_HIDG/PROC/CAM15
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM15|scene
Accessible by: |

Warning

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

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.

###### CAM16

Instance id: | HED_EXP_HIDG/PROC/CAM16
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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

[add instance documentation]

Image Processor

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

Release History
1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### CAM17

Instance id: | HED_EXP_HIDG/PROC/CAM17
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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
Scenes: | HED_EXP_HIDG/CAM/CAM17|scene
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

Release History
1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### CAM18

Instance id: | HED_EXP_HIDG/PROC/CAM18
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM18|scene
Accessible by: |

Warning

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

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.

###### CAM19

Instance id: | HED_EXP_HIDG/PROC/CAM19
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM19|scene
Accessible by: |

Warning

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

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: | HED_EXP_HIDG/PROC/CAM2
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM2|scene, HED_EXP_HIDG/CAM/CAM20|scene
Accessible by: |

Warning

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

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.

###### CAM20

Instance id: | HED_EXP_HIDG/PROC/CAM20
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM20|scene
Accessible by: |

Warning

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

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.

###### CAM21

Instance id: | HED_EXP_HIDG/PROC/CAM21
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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

[add instance documentation]

Image Processor

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

Release History
1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### CAM22

Instance id: | HED_EXP_HIDG/PROC/CAM22
Class id: | ImageProcessor
Host: | exflcon164
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-17
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’, ‘hedonc’]!

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.

###### CAM23

Instance id: | HED_EXP_HIDG/PROC/CAM23
Class id: | ImageProcessor
Host: | exflcon164
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-17
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’, ‘hedonc’]!

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: | HED_EXP_HIDG/PROC/CAM3
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM3|scene
Accessible by: |

Warning

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

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: | HED_EXP_HIDG/PROC/CAM4
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM4|scene
Accessible by: |

Warning

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

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.

###### CAM5

Instance id: | HED_EXP_HIDG/PROC/CAM5
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM5|scene
Accessible by: |

Warning

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

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.

###### CAM6

Instance id: | HED_EXP_HIDG/PROC/CAM6
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM6|scene
Accessible by: |

Warning

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

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.

###### CAM7

Instance id: | HED_EXP_HIDG/PROC/CAM7
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | test, TMP, HED_EXP_HIDG/CAM/CAM7|scene
Accessible by: |

Warning

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

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.

###### CAM8

Instance id: | HED_EXP_HIDG/PROC/CAM8
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | test, HED_EXP_HIDG/CAM/CAM8|scene
Accessible by: |

Warning

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

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.

###### CAM9

Instance id: | HED_EXP_HIDG/PROC/CAM9
Class id: | ImageProcessor
Host: | exflcon181
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-21
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: | HED_EXP_HIDG/CAM/CAM9|scene
Accessible by: |

Warning

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

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.

##### MOTOR

[add component documentation]

###### DELAY_1

Instance id: | HED_EXP_HIDG/MOTOR/DELAY_1
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | Smaract_HIBEF
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DELAY_2

Instance id: | HED_EXP_HIDG/MOTOR/DELAY_2
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | Smaract_HIBEF
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DELAY_3

Instance id: | HED_EXP_HIDG/MOTOR/DELAY_3
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_EXP_HIDG/MOTOR/DELAY_3|motorScene, Smaract_HIBEF
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DELAY_4

Instance id: | HED_EXP_HIDG/MOTOR/DELAY_4
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PMOTOR

[add component documentation]

###### DF_MOTION1

Instance id: | HED_EXP_HIDG/PMOTOR/DF_MOTION1
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### VALVE

[add component documentation]

###### MIRROR_MOVE

Instance id: | HED_EXP_HIDG/VALVE/MIRROR_MOVE
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PNACT1

Instance id: | HED_EXP_HIDG/VALVE/PNACT1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PNACT2

Instance id: | HED_EXP_HIDG/VALVE/PNACT2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUTTER_1

Instance id: | HED_EXP_HIDG/VALVE/SHUTTER_1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TW-Beam-Tranport, FESTO, HED_HPLAS_HIL/Shot_scene, HED_HPLAS_HIL/Shot_scene0, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUTTER_2

Instance id: | HED_EXP_HIDG/VALVE/SHUTTER_2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TW-Beam-Tranport, Comissining_main_scenes, FESTO, HED_IA1_FSI_MAIN, HED_HPLAS_HIL/Shot_scene, HED_STATUS_OVERVIEW, A12_alignment, A12_alignment, HED_HPLAS_HIL/Shot_scene0, HED_STATUS_OVERVIEW, HED_HPLAS_HIL/Shot_scene_old, EXP_2656_main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUTTER_3

Instance id: | HED_EXP_HIDG/VALVE/SHUTTER_3
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | FESTO
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUTTER_4

Instance id: | HED_EXP_HIDG/VALVE/SHUTTER_4
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | FESTO
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE

Instance id: | HED_EXP_HIDG/VALVE/SPARE
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SPROC

[add component documentation]

###### CAM_6

Simple Image Processor

The `SimpleImageProcessor` device is documented in simpleimageprocessor:simple-image-processor-user

Image Processor

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

#### HIT

##### VALVE

###### HI_DV_07

Instance id: | HED_EXP_HIT/VALVE/HI_DV_07
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | Crosses, TW-Beam-Tranport
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_DV_08

Instance id: | HED_EXP_HIT/VALVE/HI_DV_08
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | Crosses, TW-Beam-Tranport
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_DV_09

Instance id: | HED_EXP_HIT/VALVE/HI_DV_09
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | Crosses, HED_EXP_HIT/VALVE/HI_DV_09|scene, TW-Beam-Tranport
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HIVAC

##### GAUGE

###### HI_VMG_11

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_11
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_12

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_12
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HI-LAS-VAC, HED_IA1_VAC, HED_EXP_IA1_VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_13

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_13
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_14

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_14
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_16

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_16
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_18

Instance id: | HED_EXP_HIVAC/GAUGE/HI_VMG_18
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PUMP

###### HI_VPS_04

##### TPUMP

###### HI_VPT_04

Instance id: | HED_EXP_HIVAC/TPUMP/HI_VPT_04
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VPT_05

Instance id: | HED_EXP_HIVAC/TPUMP/HI_VPT_05
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_07

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVF_07
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_08

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVF_08
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_09

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVF_09
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_13

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_13
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_14

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_14
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_15

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_15
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_16

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_16
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_17

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_17
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_18

Instance id: | HED_EXP_HIVAC/VALVE/HI_VVS_18
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HI-LAS-VAC, HED_IA1_VAC, HED_EXP_IA1_VAC, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### IBS

##### DCTRL

###### LED

###### SCREEN_CAM

Instance id: | HED_EXP_IBS/DCTRL/SCREEN_CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | hed_exp_ibs_cam_cam|scene, COMP_HED_IBS/CrossHair
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DIAMOND_X

#### PKW

##### SWITCH

###### FL_A12_CB1_OUT1

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB1_OUT2

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB1_OUT3

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB1_OUT4

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB1_OUT5

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB1_OUT6

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB1_OUT6
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB2_OUT1

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB2_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB2_OUT2

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB2_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB2_OUT3

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB2_OUT3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB2_OUT4

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB2_OUT4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB3_OUT1

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB3_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB3_OUT2

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB3_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB3_OUT3

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB3_OUT3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FL_A12_CB3_OUT4

Instance id: | HED_EXP_PKW/SWITCH/FL_A12_CB3_OUT4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TS_A12_CB1_IN

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_IN
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT1

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT2

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT3

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT4

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT5

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT5
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB1_OUT6

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB1_OUT6
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB2_IN

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB2_IN
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB2_OUT1

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB2_OUT1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB2_OUT2

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB2_OUT2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB2_OUT3

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB2_OUT3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB2_OUT4

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB2_OUT4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB3_IN

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB3_IN
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB3_OUT1

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB3_OUT1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB3_OUT2

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB3_OUT2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB3_OUT3

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB3_OUT3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_A12_CB3_OUT4

Instance id: | HED_EXP_PKW/TSENS/TS_A12_CB3_OUT4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### 2KX2K

###### BEAMVIEW

Instance id: | HED_EXP_PSC/2KX2K/BEAMVIEW
Class id: | PhotonicScience2kx2k
Host: | exflcon165
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/photonicScienceDualCamera
Last modified: | 2020-11-25T10:17:16.000+01:00
Created at: | 2017-02-13T13:17:16.000+01:00
Main authors: | Parenti, Hauf, Kirienko
Latest tag: | 1.2.2-2.10.0
Deployment tag: | 1.2.2-2.10.0
Scenes: | HED_EXP_PSC/P2KX2K
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- frameRateIn:
    The incoming frame rate.
- frameRateOut:
    The outgoing frame rate.

Release History
1.2.2-2.10.0

Created: | 2020-11-25T10:03:30.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.1-2.8.3

Created: | 2020-06-03T10:20:05.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessor to latest tag

1.2.0-2.6.4

Created: | 2019-12-06T16:01:10.000Z
Author: | Yury Kirienko
Notes: | PhotonicScienceCalibrator was rewritten from scratch.

1.1.0-2.6.2

Created: | 2019-10-18T15:12:22.000Z
Author: | Andrea Parenti
Notes: | Add descrambling device for 2k x 2k single GigE camera

1.0.0-2.4

Created: | 2019-05-20T10:46:32.000Z
Author: | Andrea Parenti
Notes: | ADD PhotonicScienceCalibrator for reference subtraction ADD tests and CI configuration

0.3.0-2.2.6

Created: | 2018-10-24T13:28:02.000Z
Author: | Andrea Parenti
Notes: | Finish update for 2.2.x Remove file saving feature

0.2.0-2.2.4

Created: | 2018-09-21T09:49:36.000Z
Author: | Yury Kirienko
Notes: |

0.1.0-1.4

Created: | 2016-07-25T10:20:54.000Z
Author: | Andrea Parenti
Notes: | Package photonicScienceDualCamera got tagged from “branches/0.1-1.4” to “tags/0.1.0-1.4” via karabo script

##### AVG

###### BEAMVIEW

Instance id: | HED_EXP_PSC/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_EXP_PSC/PROC_AVG_BKS, HED_EXP_PSC/P2KX2K
Accessible by: |

Warning

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

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.

##### BKS

###### BEAMVIEW

Instance id: | HED_EXP_PSC/BKS/BEAMVIEW
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_EXP_PSC/PROC_AVG_BKS, HED_EXP_PSC/P2KX2K, BG_subtracted_IMAGE
Accessible by: |

Warning

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

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.

##### CAM

###### BEAMVIEW

Instance id: | HED_EXP_PSC/CAM/BEAMVIEW
Class id: | PhotonicScienceCamera
Host: | exflcon165
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2020-10-09T11:17:20.000+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti
Latest tag: | 3.11.5-2.9.8
Deployment tag: | 3.11.5-2.9.8
Scenes: | HED_EXP_PSC/CAM/BEAMVIEW|overview, HED_EXP_PSC/CAM/BEAMVIEW|scene, HED_EXP_PSC/PROC_AVG_BKS, HED_EXP_PSC/P2KX2K, BG_subtracted_IMAGE
Accessible by: |

Warning

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

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

3.6.5-2.2.0

Created: | 2017-12-12T13:53:06.000Z
Author: | Andrea Parenti
Notes: | Update to Karabo 2.2 CameraFsm (State.STOPPED -> ON)

3.6.4-2.1.18

Created: | 2017-12-06T09:16:24.000Z
Author: | Andrea Parenti
Notes: | Apply initial parameters to BobcatCamera Remove parameters from incoming reconfiguration if setting failed Quit poll loop after max 1 sec if shutdown is required Round PhotonicScience’s width to closest 16 multiple

##### PROC

###### BEAMVIEW

Instance id: | HED_EXP_PSC/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_EXP_PSC/PROC_AVG_BKS
Accessible by: |

Warning

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

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

###### BEAMVIEW

Instance id: | HED_EXP_PSC/TSYS/BEAMVIEW
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | ZYLA_2151_Henry, EXP_2656_main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### SCOPE

###### TRIGGER_1

Instance id: | HED_EXP_SCOPE/SCOPE/TRIGGER_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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_2

Instance id: | HED_EXP_SCOPE/SCOPE/TRIGGER_2
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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_3

Instance id: | HED_EXP_SCOPE/SCOPE/TRIGGER_3
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### SPP

##### ASENS

###### AI_1

Instance id: | HED_EXP_SPP/ASENS/AI_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_2

Instance id: | HED_EXP_SPP/ASENS/AI_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_3

Instance id: | HED_EXP_SPP/ASENS/AI_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_4

Instance id: | HED_EXP_SPP/ASENS/AI_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_1

Instance id: | HED_EXP_SPP/DCTRL/DI_1
Host: | exflcon152
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### DI_2

Instance id: | HED_EXP_SPP/DCTRL/DI_2
Host: | exflcon152
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### DO_1

Instance id: | HED_EXP_SPP/DCTRL/DO_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_IA1_VAC, Comissining_main_scenes, HED_EXP_MAIN, LEDs, LEDs, HED_STATUS_OVERVIEW, HED_IA1_IC-LEDs, A12_alignment, APP_EXP_2716/SampleAlignment, Sample_alignment, A12_alignment, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/HED_ILLUMINATION
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_2

Instance id: | HED_EXP_SPP/DCTRL/DO_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_3

Instance id: | HED_EXP_SPP/DCTRL/DO_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_4

Instance id: | HED_EXP_SPP/DCTRL/DO_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_IA1_FSSS_MAIN_old, HED_EXP_IA1_VAC, Comissining_main_scenes, HED_EXP_MAIN, LEDs, LEDs, HED_IA1_IC/CAM/FISHEYE_VIEW|scene, HED_IA1_LASER_ALIGNMENT, HED_STATUS_OVERVIEW, HED_IA1_IC-CAM-FISHEYE_VIEW-scene, HED_IA1_IC-LEDs, A12_alignment, APP_EXP_2716/AligmentScene, APP_EXP_2716/SampleAlignment, Sample_alignment, A12_alignment, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/HED_ILLUMINATION, Masterview, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_5

Instance id: | HED_EXP_SPP/DCTRL/DO_5
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_6

Instance id: | HED_EXP_SPP/DCTRL/DO_6
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ENC_BISS_1

###### ENC_BISS_2

###### ENC_INC_1

###### ENC_INC_2

###### ENC_SINCOS_1

###### ENC_SINCOS_2

###### ENC_SSI_1

###### ENC_SSI_2

##### MOTOR

###### SM_L_1

###### SM_L_2

###### SM_L_3

###### SM_L_4

###### SM_M_1

###### SM_M_2

###### SM_M_3

###### SM_M_4

###### SM_S_1

###### SM_S_2

###### SM_S_3

###### SM_S_4

###### ENC_SINCOS_2

Instance id: | HED_EXP_SPP/MOTOR/ENC_SINCOS_2
Host: | exflcon152
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### SWITCH

###### DI_1

Instance id: | HED_EXP_SPP/SWITCH/DI_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_IA1_VAC/VALVE/IC1_GV05|InterlockOverview, HED_IA1_VAC/VALVE/IC1_GV03|InterlockOverview, HED_IA1_VAC/VALVE/IC1_GV02|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_2

Instance id: | HED_EXP_SPP/SWITCH/DI_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_IA1_VAC/VALVE/IC1_GV05|InterlockOverview, HED_IA1_VAC/VALVE/IC1_GV03|InterlockOverview, HED_IA1_VAC/VALVE/IC1_GV02|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_3

Instance id: | HED_EXP_SPP/SWITCH/DI_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_4

Instance id: | HED_EXP_SPP/SWITCH/DI_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_5

Instance id: | HED_EXP_SPP/SWITCH/DI_5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_6

Instance id: | HED_EXP_SPP/SWITCH/DI_6
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_1

Instance id: | HED_EXP_SPP/TSENS/T_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_2

Instance id: | HED_EXP_SPP/TSENS/T_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_3

Instance id: | HED_EXP_SPP/TSENS/T_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_4

Instance id: | HED_EXP_SPP/TSENS/T_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_5

Instance id: | HED_EXP_SPP/TSENS/T_5
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_6

Instance id: | HED_EXP_SPP/TSENS/T_6
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_7

Instance id: | HED_EXP_SPP/TSENS/T_7
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_8

Instance id: | HED_EXP_SPP/TSENS/T_8
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### ACTRL

###### AO_1

Instance id: | HED_EXP_SPP/ACTRL/AO_1
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_2

Instance id: | HED_EXP_SPP/ACTRL/AO_2
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_3

Instance id: | HED_EXP_SPP/ACTRL/AO_3
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_4

Instance id: | HED_EXP_SPP/ACTRL/AO_4
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### VDCTRL

[add component documentation]

###### DI_1

Instance id: | HED_EXP_SPP/VDCTRL/DI_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### DI_2

Instance id: | HED_EXP_SPP/VDCTRL/DI_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

##### VSWITCH

[add component documentation]

###### DI_1

Instance id: | HED_EXP_SPP/VSWITCH/DI_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-24T17:01:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti
Latest tag: | 4.6.4-2.11.1-peltier-hotfix-@SPB
Deployment tag: | 4.6.4-2.11.1-peltier-hotfix-@SPB
Installed tag: | 4.6.1-2.11.0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.1-2.11.0) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

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

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### DI_2

Instance id: | HED_EXP_SPP/VSWITCH/DI_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-24T17:01:11.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti
Latest tag: | 4.6.4-2.11.1-peltier-hotfix-@SPB
Deployment tag: | 4.6.4-2.11.1-peltier-hotfix-@SPB
Installed tag: | 4.6.1-2.11.0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.1-2.11.0) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

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

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

#### SYS

##### TSYS

###### UTC-1-S2

Instance id: | HED_EXP_SYS/TSYS/UTC-1-S2
Class id: | X2Timer
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | AGIPD500K2G-Control_new, AGIPD500K2G-Control_new_jsd
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

#### VAC1

##### DCTRL

###### RL_PUMP_PUMPS_ON

Instance id: | HED_EXP_VAC1/DCTRL/RL_PUMP_PUMPS_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_PUMP_RPUMP_ON

Instance id: | HED_EXP_VAC1/DCTRL/RL_PUMP_RPUMP_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_PG01

Instance id: | HED_EXP_VAC1/GAUGE/RL_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG01

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_EXP_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG02

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG03

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG04

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG05

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG05
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG06

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG06
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG07

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG07
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_PG08

Instance id: | HED_EXP_VAC1/GAUGE/SPP_PG08
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_CTRL

Instance id: | HED_EXP_VAC1/ICTRL/IP_CTRL
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_LSHUT

Instance id: | HED_EXP_VAC1/IPUMP/IP_LSHUT
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE1

Instance id: | HED_EXP_VAC1/IPUMP/SPARE1
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE2

Instance id: | HED_EXP_VAC1/IPUMP/SPARE2
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE3

Instance id: | HED_EXP_VAC1/IPUMP/SPARE3
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SWITCH

###### RL_PUMP_ALARM

Instance id: | HED_EXP_VAC1/SWITCH/RL_PUMP_ALARM
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_PUMP_DP_RUNNING

Instance id: | HED_EXP_VAC1/SWITCH/RL_PUMP_DP_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_PUMP_PR_RUNNING

Instance id: | HED_EXP_VAC1/SWITCH/RL_PUMP_PR_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_PUMP_READY

Instance id: | HED_EXP_VAC1/SWITCH/RL_PUMP_READY
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | APP_HED_VAC_RP, APP_HED_VAC_RP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TPUMP

###### SPP_TP01

Instance id: | HED_EXP_VAC1/TPUMP/SPP_TP01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_TP02

Instance id: | HED_EXP_VAC1/TPUMP/SPP_TP02
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### RL_GV01

Instance id: | HED_EXP_VAC1/VALVE/RL_GV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, IC2_status, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV01

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, IC2_status, HED_EXP_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV02

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_IA1_FSSS_MAIN_old, HED_EXP_MAIN, HED_OGT_ALAS_MAIN, HED_IA1_LASER_ALIGNMENT, HED_STATUS_OVERVIEW, APP_EXP_2716/SampleAlignment, Sample_alignment, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV03

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_STATUS_OVERVIEW, EPIX_MAIN, HED_STATUS_OVERVIEW, EPIX100-1_TED, EPIX100-2_TED, EPIX100-3_TED
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV04

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | ALL_DET_CTRL_old, EPIX100-1_INTERLOCK, EPIX100-2_INTERLOCK, HED_STATUS_OVERVIEW, ALL_DET_CTRL, ALL_DET_CTRL_2716, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV05

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPP_VV06

Instance id: | HED_EXP_VAC1/VALVE/SPP_VV06
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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]

###### IP_LSHUT

Instance id: | HED_EXP_VAC1/VDCTRL/IP_LSHUT
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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]

###### IP_LSHUT

Instance id: | HED_EXP_VAC1/VSWITCH/IP_LSHUT
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### VAC2

##### GAUGE

###### AC_PG01

Instance id: | HED_EXP_VAC2/GAUGE/AC_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_PG02

Instance id: | HED_EXP_VAC2/GAUGE/AC_PG02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG01

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG02

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG03

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG04

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_IA2_IC2, HED_EXP_IA1_VAC, IC2_status, IC2_SAMPLESTACK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG05

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG05
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_IA2_IC2, HED_EXP_IA1_VAC, IC2_status, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_PG06

Instance id: | HED_EXP_VAC2/GAUGE/IC2_PG06
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PUMP

###### IC2_SP01

##### SWITCH

###### IC2_IN

Instance id: | HED_EXP_VAC2/SWITCH/IC2_IN
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TPUMP

###### AC_TP01

Instance id: | HED_EXP_VAC2/TPUMP/AC_TP01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC_TP01

Instance id: | HED_EXP_VAC2/TPUMP/IC_TP01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC_TP02

Instance id: | HED_EXP_VAC2/TPUMP/IC_TP02
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_AV01

Instance id: | HED_EXP_VAC2/VALVE/AC_AV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_GV01

Instance id: | HED_EXP_VAC2/VALVE/AC_GV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_GV02

Instance id: | HED_EXP_VAC2/VALVE/AC_GV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_GV03

Instance id: | HED_EXP_VAC2/VALVE/AC_GV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AC_GV04

Instance id: | HED_EXP_VAC2/VALVE/AC_GV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_AV01

Instance id: | HED_EXP_VAC2/VALVE/IC2_AV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_AV03

Instance id: | HED_EXP_VAC2/VALVE/IC2_AV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_GV01

Instance id: | HED_EXP_VAC2/VALVE/IC2_GV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, IC2_status
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_GV02

Instance id: | HED_EXP_VAC2/VALVE/IC2_GV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, IC2_status
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_GV03

Instance id: | HED_EXP_VAC2/VALVE/IC2_GV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, IC2_status
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC2_GV04

Instance id: | HED_EXP_VAC2/VALVE/IC2_GV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_VALVE_1

Instance id: | HED_EXP_VAC2/VALVE/SPARE_VALVE_1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_VALVE_2

Instance id: | HED_EXP_VAC2/VALVE/SPARE_VALVE_2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### BIS

###### TPUMP

IC_TP02

Instance id: | HED_EXP_VAC2_BIS/TPUMP/IC_TP02
Host: | exflcon154
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

#### VAREX

##### BKGS

###### 1

Instance id: | HED_EXP_VAREX/BKGS/1
Class id: | ImageBackgroundSubtraction
Host: | exflcon175
Alias: | hed-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: | HED_EXP_VAREX/CAM/1|scene, IC2_VAREX_1, IC2_VAREX_2
Accessible by: |

Warning

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

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.

###### 2

Instance id: | HED_EXP_VAREX/BKGS/2
Class id: | ImageBackgroundSubtraction
Host: | exflcon175
Alias: | hed-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: | HED_EXP_VAREX/CAM/2|scene
Accessible by: |

Warning

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

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.

##### CAM

###### 1

###### 2

##### AVG

[add component documentation]

###### 1

Instance id: | HED_EXP_VAREX/AVG/1
Class id: | ImageAverager
Host: | exflcon175
Alias: | hed-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’, ‘hedonc’]!

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.

###### 2

Instance id: | HED_EXP_VAREX/AVG/2
Class id: | ImageAverager
Host: | exflcon175
Alias: | hed-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’, ‘hedonc’]!

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.

##### PROC

[add component documentation]

###### 1

Instance id: | HED_EXP_VAREX/PROC/1
Class id: | ImageProcessor
Host: | exflcon175
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

#### SPEC

##### MOTOR

###### AXIS_1

###### AXIS_10

###### AXIS_2

###### AXIS_3

###### AXIS_4

###### AXIS_5

###### AXIS_6

###### AXIS_7

###### AXIS_8

###### AXIS_9

###### AXIS_11

###### AXIS_12

###### AXIS_13

###### AXIS_14

###### AXIS_15

###### AXIS_16

###### AXIS_17

###### AXIS_18

###### AXIS_19

###### AXIS_20

##### ACTRL

[add component documentation]

###### AO_1

Instance id: | HED_EXP_SPEC/ACTRL/AO_1
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_2

Instance id: | HED_EXP_SPEC/ACTRL/AO_2
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_3

Instance id: | HED_EXP_SPEC/ACTRL/AO_3
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SWITCH

[add component documentation]

###### DI_1

Instance id: | HED_EXP_SPEC/SWITCH/DI_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_2

Instance id: | HED_EXP_SPEC/SWITCH/DI_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_3

Instance id: | HED_EXP_SPEC/SWITCH/DI_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_4

Instance id: | HED_EXP_SPEC/SWITCH/DI_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_5

Instance id: | HED_EXP_SPEC/SWITCH/DI_5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_6

Instance id: | HED_EXP_SPEC/SWITCH/DI_6
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### ZYLA

[add component documentation]

##### AVG

[add component documentation]

###### 1

Instance id: | HED_EXP_ZYLA/AVG/1
Class id: | ImageAverager
Host: | exflcon163
Alias: | hed-rr-sys-con-10
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’, ‘hedonc’]!

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.

###### 2

Instance id: | HED_EXP_ZYLA/AVG/2
Class id: | ImageAverager
Host: | exflcon169
Alias: | hed-rr-sys-con-15
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: | ZYLA2_AVG
Accessible by: |

Warning

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

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.

##### BRIDGE

[add component documentation]

###### F

Instance id: | HED_EXP_ZYLA/BRIDGE/F
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

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

[add instance documentation]

Release History
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: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

###### 2

Instance id: | HED_EXP_ZYLA/BRIDGE/2
Class id: | PipeToZeroMQ
Host: | exflonc27
Alias: | la2-br-kc-comp-3 , sa2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.

Release History
3.2.4-2.10.0

Created: | 2020-11-18T10:03:59.000Z
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T17:59:22.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T16:23:38.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T11:23:45.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

##### CAM

[add component documentation]

###### 1

Instance id: | HED_EXP_ZYLA/CAM/1
Class id: | AndorZylaCamera
Host: | exflcon163
Alias: | hed-rr-sys-con-10
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: | ZYLA_2569, wert, ZYLA_2180, TEST_ZYLA_v20, ZYLA_2434, ZYLA_2575_DS, ZYLA_2575_US, ZYLA_2151_Henry, ZYLA_2151_Peter, TEST_ZYLA, ZYLA, ZYLA2434
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### 2

Instance id: | HED_EXP_ZYLA/CAM/2
Class id: | AndorZylaCamera
Host: | exflcon169
Alias: | hed-rr-sys-con-15
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: | ZYLA_2575_US, TEST_ZYLA_2, ZYLA_USB, ZYLA_2151_Taper0, ZYLA2_2151_Peter, ZYLA2_2151_Peter, ZYLA_COM_Aug20200, HED_SPECTATOR_MAIN, APP_HED-FLEX/Main
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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
- AOILayout:
    AOILayout
- 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
- MultitrackBinned:
    MultitrackBinned
- MultitrackCount:
    MultitrackCount
- MultitrackEnd:
    MultitrackEnd
- MultitrackSelector:
    MultitrackSelector
- MultitrackStart:
    MultitrackStart
- 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-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

###### 5

Instance id: | HED_EXP_ZYLA/CAM/5
Class id: | AndorZylaCamera
Host: | hed-rr-sys-con-15
Alias: | hed-rr-sys-con-15
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: | ZYLA5_OptPeter_TWexp, ZYLA5_OptPeter_BGsubtracted_averaged_, HED_SPECTATOR_MAIN, Masterview, ZYLA5_OP_PAMcamera0, ZYLA5_OP_PAMcamera, MasterView_Old, Optique_Peter
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

###### HF

Instance id: | HED_EXP_ZYLA/CAM/HF
Class id: | AndorZylaCamera
Host: | hed-rr-sys-con-15
Alias: | hed-rr-sys-con-15
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: | Zyla_HF
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

##### MATCHER

[add component documentation]

###### 0

Instance id: | HED_EXP_ZYLA/MATCHER/0
Class id: | TrainMatcher
Host: | exflonc27
Alias: | la2-br-kc-comp-3 , sa2-br-kc-comp-3
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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

###### 2

Instance id: | HED_EXP_ZYLA/MATCHER/2
Class id: | TrainMatcher
Host: | exflonc27
Alias: | la2-br-kc-comp-3 , sa2-br-kc-comp-3
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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

###### Z2

Instance id: | HED_EXP_ZYLA/MATCHER/Z2
Class id: | TrainMatcher
Host: | exflonc27
Alias: | la2-br-kc-comp-3 , sa2-br-kc-comp-3
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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

##### PROC

[add component documentation]

###### 1

Instance id: | HED_EXP_ZYLA/PROC/1
Class id: | ImageProcessor
Host: | exflcon163
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-10
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: | ZYLA_SCAN, ZYLA_SCAN, APP_HED-FLEX/Main
Accessible by: |

Warning

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

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.

###### 2

Instance id: | HED_EXP_ZYLA/PROC/2
Class id: | ImageProcessor
Host: | exflcon169
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-15
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’, ‘hedonc’]!

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.

##### BKGS

[add component documentation]

###### 2

Instance id: | HED_EXP_ZYLA/BKGS/2
Class id: | ImageBackgroundSubtraction
Host: | exflcon169
Alias: | hed-rr-sys-con-15
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: | HED_EXP_ZYLA2/background_substradction
Accessible by: |

Warning

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

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.

#### PIXIS

[add component documentation]

##### CAM

[add component documentation]

###### PIXIS_1

Instance id: | HED_EXP_PIXIS/CAM/PIXIS_1
Host: | exflcon191
Alias: | hed-rr-sys-con-22
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/princetonCameras
Last modified: | 2020-01-16T14:11:12.000+01:00
Created at: | 2017-03-20T18:58:09.000+01:00
Main authors: | 3309, Marsa, Xctrl
Latest tag: | 1.1.1-2.7.0
Deployment tag: | 1.1.1-2.7.0
Installed tag: | None
Scenes: | Pixis
Accessible by: | CONTROLS, DA, dreyerjo

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘1.1.1-2.7.0’])!

[add instance documentation]

Release History
1.1.1-2.7.0

Created: | 2019-12-06T06:35:40.000Z
Author: | Dreyer, Dr. Joern (FWKH) - 3309
Notes: |

1.1.0-2.7.0

Created: | 2019-11-08T08:20:46.000Z
Author: | Dreyer, Dr. Joern (FWKH) - 3309
Notes: |

1.0.0-2.5.0

Created: | 2019-08-27T05:53:52.000Z
Author: | Dreyer, Dr. Joern (FWKH) - 3309
Notes: |

#### PPT

[add component documentation]

##### CAM

[add component documentation]

###### CAM_1

Instance id: | HED_EXP_PPT/CAM/CAM_1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_EXP_PPT/CAM/CAM_1|scene, HED_EXP_PPT/CAM/CAM_1|scene, Iris_A07_PP_MAIN, Iris_A07_PP_MAIN, Iris_A07, PP_alignment
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_2

Instance id: | HED_EXP_PPT/CAM/CAM_2
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_EXP_PPT/CAM/CAM_2|scene, HED_EXP_PPT/CAM/CAM_2|scene, Iris_A07_PP_MAIN, Iris_A07_PP_MAIN, Iris_A07, PP_alignment
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### ASENS

[add component documentation]

###### HUMIDITY_1

Instance id: | HED_EXP_PPT/ASENS/HUMIDITY_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HUMIDITY_2

Instance id: | HED_EXP_PPT/ASENS/HUMIDITY_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ROOMTEMP_1

Instance id: | HED_EXP_PPT/ASENS/ROOMTEMP_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ROOMTEMP_2

Instance id: | HED_EXP_PPT/ASENS/ROOMTEMP_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### SHUT_1_COIL

Instance id: | HED_EXP_PPT/DCTRL/SHUT_1_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUT_2_COIL

Instance id: | HED_EXP_PPT/DCTRL/SHUT_2_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### DELAY_HI_1

###### DELAY_HI_2

###### DELAY_PP_1

###### DELAY_PP_2

###### DELAY_SPARE_1

###### DELAY_SPARE_2

###### DELAY_SPARE_3

###### DELAY_SPARE_4

###### MIRR1_H

###### MIRR1_V

###### MIRR2E_H

###### MIRR2E_V

###### MIRR3E_H

###### MIRR3E_V

###### MIRR4E_H

###### MIRR4E_V

###### MIRR5E_H

###### MIRR5E_V

##### SWITCH

[add component documentation]

###### SHUT_1_LO

Instance id: | HED_EXP_PPT/SWITCH/SHUT_1_LO
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUT_2_LO

Instance id: | HED_EXP_PPT/SWITCH/SHUT_2_LO
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### TEMP_1

Instance id: | HED_EXP_PPT/TSENS/TEMP_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_2

Instance id: | HED_EXP_PPT/TSENS/TEMP_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_3

Instance id: | HED_EXP_PPT/TSENS/TEMP_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HEVAC

[add component documentation]

##### GAUGE

[add component documentation]

###### HI_VMG_06

Instance id: | HED_EXP_HEVAC/GAUGE/HI_VMG_06
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_09

Instance id: | HED_EXP_HEVAC/GAUGE/HI_VMG_09
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### AGIPD500K2G

[add component documentation]

##### FPGA

[add component documentation]

###### M_0

###### M_1

###### M_2

###### M_3

###### M_4

###### M_5

###### M_6

###### M_7

##### MDL

[add component documentation]

###### SEQ_POWER

###### TAG_GROUP

Instance id: | HED_EXP_AGIPD500K2G/MDL/TAG_GROUP
Class id: | TagGroup
Host: | hed-rr-sys-con-16
Alias: | hed-rr-sys-con-16
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_mini_half_power, eight_channels_simple, AGIPD_mini_half_power
Accessible by: | CAL, CONTROLS, CTRL, DA, cerantol, danilevc, jsztuk, prestont, stern, 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
- 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.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: |

###### FPGA_COMP

###### DAQ_CONTROLLER

###### DARK_PROC

##### CAL

[add component documentation]

###### APPEND_CORRECTED

Instance id: | HED_EXP_AGIPD500K2G/CAL/APPEND_CORRECTED
Class id: | CppFemCombiner
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | HED_EXP_AGIPD500K2G/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW_GAIN

Instance id: | HED_EXP_AGIPD500K2G/CAL/APPEND_RAW_GAIN
Class id: | CppFemCombiner
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### CAL_MANAGER

Instance id: | HED_EXP_AGIPD500K2G/CAL/CAL_MANAGER
Class id: | CalManager
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

Release History
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: |

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

###### COMBINE_CORRECTED

Instance id: | HED_EXP_AGIPD500K2G/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-08-31T19:22:33.000+02: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
Accessible by: |

Warning

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

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: | HED_EXP_AGIPD500K2G/CAL/COMBINE_RAW
Class id: | FemDataAssembler
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-08-31T19:22:33.000+02: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
Accessible by: |

Warning

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

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: | HED_EXP_AGIPD500K2G/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-08-31T19:22:33.000+02: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
Accessible by: |

Warning

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

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: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q1M1
Class id: | CppFemSplitter
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M2

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q1M2
Class id: | CppFemSplitter
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M3

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q1M3
Class id: | CppFemSplitter
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M4

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q1M4
Class id: | CppFemSplitter
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M1

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q2M1
Class id: | CppFemSplitter
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M2

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q2M2
Class id: | CppFemSplitter
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M3

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q2M3
Class id: | CppFemSplitter
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M4

Instance id: | HED_EXP_AGIPD500K2G/CAL/FEM_SPLITTER_Q2M4
Class id: | CppFemSplitter
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-08-31T19:22:02.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Ahmed
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

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

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

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### OFFSET_CORR_Q1M1

Instance id: | HED_EXP_AGIPD500K2G/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-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q1M2

Instance id: | HED_EXP_AGIPD500K2G/CAL/OFFSET_CORR_Q1M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q1M3

Instance id: | HED_EXP_AGIPD500K2G/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-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q1M4

Instance id: | HED_EXP_AGIPD500K2G/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-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q2M1

Instance id: | HED_EXP_AGIPD500K2G/CAL/OFFSET_CORR_Q2M1
Class id: | OffsetCorrectionAGIPD
Host: | exflong10
Alias: | mid-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q2M2

Instance id: | HED_EXP_AGIPD500K2G/CAL/OFFSET_CORR_Q2M2
Class id: | OffsetCorrectionAGIPD
Host: | exflong14
Alias: | mid-br-sys-cal-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q2M3

Instance id: | HED_EXP_AGIPD500K2G/CAL/OFFSET_CORR_Q2M3
Class id: | OffsetCorrectionAGIPD
Host: | exflong12
Alias: | mid-br-sys-cal-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

###### OFFSET_CORR_Q2M4

Instance id: | HED_EXP_AGIPD500K2G/CAL/OFFSET_CORR_Q2M4
Class id: | OffsetCorrectionAGIPD
Host: | exflong13
Alias: | mid-br-sys-cal-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-09-22T17:07:39.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.16.0-2.9.1
Deployment tag: | 1.16.0-2.9.1
Accessible by: |

Warning

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

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

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

#### VISAR

[add component documentation]

##### DCTRL

[add component documentation]

###### ARM_1_FILTER_1

Instance id: | HED_EXP_VISAR/DCTRL/ARM_1_FILTER_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_1_FILTER_2

Instance id: | HED_EXP_VISAR/DCTRL/ARM_1_FILTER_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_1_FILTER_3

Instance id: | HED_EXP_VISAR/DCTRL/ARM_1_FILTER_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_1

Instance id: | HED_EXP_VISAR/DCTRL/ARM_2_FILTER_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_2

Instance id: | HED_EXP_VISAR/DCTRL/ARM_2_FILTER_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_3

Instance id: | HED_EXP_VISAR/DCTRL/ARM_2_FILTER_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_1

Instance id: | HED_EXP_VISAR/DCTRL/ARM_3_FILTER_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_2

Instance id: | HED_EXP_VISAR/DCTRL/ARM_3_FILTER_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_3

Instance id: | HED_EXP_VISAR/DCTRL/ARM_3_FILTER_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_1

Instance id: | HED_EXP_VISAR/DCTRL/IMAGE_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_2

Instance id: | HED_EXP_VISAR/DCTRL/IMAGE_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_3

Instance id: | HED_EXP_VISAR/DCTRL/IMAGE_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_4

Instance id: | HED_EXP_VISAR/DCTRL/IMAGE_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_5

Instance id: | HED_EXP_VISAR/DCTRL/IMAGE_5
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### ARM_1_DELAY

###### ARM_2_DELAY

###### ARM_3_DELAY

##### SWITCH

[add component documentation]

###### ARM_1_FILTER_1

Instance id: | HED_EXP_VISAR/SWITCH/ARM_1_FILTER_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_1_FILTER_2

Instance id: | HED_EXP_VISAR/SWITCH/ARM_1_FILTER_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_1_FILTER_3

Instance id: | HED_EXP_VISAR/SWITCH/ARM_1_FILTER_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_1

Instance id: | HED_EXP_VISAR/SWITCH/ARM_2_FILTER_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_2

Instance id: | HED_EXP_VISAR/SWITCH/ARM_2_FILTER_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_2_FILTER_3

Instance id: | HED_EXP_VISAR/SWITCH/ARM_2_FILTER_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_1

Instance id: | HED_EXP_VISAR/SWITCH/ARM_3_FILTER_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_2

Instance id: | HED_EXP_VISAR/SWITCH/ARM_3_FILTER_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_3_FILTER_3

Instance id: | HED_EXP_VISAR/SWITCH/ARM_3_FILTER_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_1

Instance id: | HED_EXP_VISAR/SWITCH/IMAGE_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_2

Instance id: | HED_EXP_VISAR/SWITCH/IMAGE_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_3

Instance id: | HED_EXP_VISAR/SWITCH/IMAGE_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_4

Instance id: | HED_EXP_VISAR/SWITCH/IMAGE_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IMAGE_5

Instance id: | HED_EXP_VISAR/SWITCH/IMAGE_5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TSYS

[add component documentation]

###### ARM_1_GATE

Instance id: | HED_EXP_VISAR/TSYS/ARM_1_GATE
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### ARM_1_TRIG

Instance id: | HED_EXP_VISAR/TSYS/ARM_1_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### ARM_2_GATE

Instance id: | HED_EXP_VISAR/TSYS/ARM_2_GATE
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### ARM_2_TRIG

Instance id: | HED_EXP_VISAR/TSYS/ARM_2_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### ARM_3_GATE

Instance id: | HED_EXP_VISAR/TSYS/ARM_3_GATE
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | COMP_HED_VISAR/TimingStreak
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### ARM_3_TRIG

Instance id: | HED_EXP_VISAR/TSYS/ARM_3_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### LASER_AMP1

Instance id: | HED_EXP_VISAR/TSYS/LASER_AMP1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | COMP_HED_VISAR/VisarLaser
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### LASER_AMP2

Instance id: | HED_EXP_VISAR/TSYS/LASER_AMP2
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | COMP_HED_VISAR/VisarLaser
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### LASER_AMP3

Instance id: | HED_EXP_VISAR/TSYS/LASER_AMP3
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | COMP_HED_VISAR/VisarLaser
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### LASER_OSC

Instance id: | HED_EXP_VISAR/TSYS/LASER_OSC
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | COMP_HED_VISAR/VisarLaser
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### SOP_GATE

Instance id: | HED_EXP_VISAR/TSYS/SOP_GATE
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### SOP_TRIG

Instance id: | HED_EXP_VISAR/TSYS/SOP_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### DA

[add component documentation]

##### METRO

[add component documentation]

###### CAM_PROCESSOR

#### AIR

[add component documentation]

##### TSENS

[add component documentation]

###### THB1

###### THB2

#### DP014

[add component documentation]

##### CTRL

[add component documentation]

###### LASER_POWER_METER

#### TEMP

[add component documentation]

##### CTRL

[add component documentation]

###### KEITHLEY-1

Instance id: | HED_EXP_TEMP/CTRL/KEITHLEY-1
Class id: | Keithley6514
Host: | hed-rr-sys-con-17
Alias: | hed-rr-sys-con-17
Git repo: | https://git.xfel.eu/karaboDevices/Keithley6514
Last modified: | 2021-09-29T11:20:23.716+02:00
Created at: | 2019-07-01T11:51:53.000+02:00
Main authors: | Fabbri, Haufs, Danilevski
Latest tag: | 1.1.0-2.11.4
Deployment tag: | 1.1.0-2.11.4
Scenes: | Diodes
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Device is installed in development mode!

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
- url:
    The URL of the instrument. Supported URL schemes are
      socket://hostname:port/ and file:///filename
- timeout:
    Max time to wait for an answer to a command/query.
      If negative, the response will be waited for forever. Devices whose protocol foresee commands w/o answer will not work with negative timeouts!
- value:
    The current value from the current measurement mode
- damping:
    Enabling damping reduces capacitance noise measurements for current measurements
- autoZero:
    Periodically measure internal voltages corresponding to offsets and amplifiers gains. This functionality is embedded in HW.
- integrationRate:
    The rate setting is global for all measurement functions. SLOW is 100ms. MED is 20ms. FAST is 2ms. Slower rates provide better noise performance. Faster rates provide faster readouts.
- voltageAuto:
    The instrument automatically goes to the most sensitiveavailable range to measure the applied signal.
- currentAuto:
    The instrument automatically goes to the most sensitiveavailable range to measure the applied signal.
- resistanceAuto:
    The instrument automatically goes to the most sensitivea vailable range to measure the applied signal.
- chargeAuto:
    The instrument automatically goes to the most sensitivea vailable range to measure the applied signal.
- chargeAutoGroup:
    The instrument only autoranges between two groups. HIGH ranges between 2C and 20C. LOW ranges between 20nC and 200nC
- medianFilterRank:
    See manual, it’s too long to fit here
- sqsMode:
    Upon start-up, set measurement mode to current, do zero correction, set slow rate

Release History
1.1.0-2.11.4

Created: | 2021-09-29T11:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | Compatible with Karabo 2.11.x Polling interval is configurable.

1.1.0-2.11.4-rc2

Created: | 2021-09-29T10:01:27.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.11.4-rc1

Created: | 2021-09-27T09:43:12.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.0.2-2.10.0

Created: | 2020-12-02T18:23:46.000+01:00
Author: | Riccardo Fabbri
Notes: | Add Karabo 2.10 Versioning Info

1.0.1-2.5.1

Created: | 2019-08-20T16:41:31.000+02:00
Author: | Cyril Danilevski
Notes: | Fix value reading

1.0.0-2.5.1

Created: | 2019-08-05T15:55:32.000+02:00
Author: | Cyril Danilevski
Notes: | First implementation

###### KEITHLEY-2

Instance id: | HED_EXP_TEMP/CTRL/KEITHLEY-2
Class id: | Keithley6514
Host: | hed-rr-sys-con-17
Alias: | hed-rr-sys-con-17
Git repo: | https://git.xfel.eu/karaboDevices/Keithley6514
Last modified: | 2021-09-29T11:20:23.716+02:00
Created at: | 2019-07-01T11:51:53.000+02:00
Main authors: | Fabbri, Haufs, Danilevski
Latest tag: | 1.1.0-2.11.4
Deployment tag: | 1.1.0-2.11.4
Scenes: | Diodes
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Device is installed in development mode!

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
- url:
    The URL of the instrument. Supported URL schemes are
      socket://hostname:port/ and file:///filename
- timeout:
    Max time to wait for an answer to a command/query.
      If negative, the response will be waited for forever. Devices whose protocol foresee commands w/o answer will not work with negative timeouts!
- value:
    The current value from the current measurement mode
- damping:
    Enabling damping reduces capacitance noise measurements for current measurements
- autoZero:
    Periodically measure internal voltages corresponding to offsets and amplifiers gains. This functionality is embedded in HW.
- integrationRate:
    The rate setting is global for all measurement functions. SLOW is 100ms. MED is 20ms. FAST is 2ms. Slower rates provide better noise performance. Faster rates provide faster readouts.
- voltageAuto:
    The instrument automatically goes to the most sensitiveavailable range to measure the applied signal.
- currentAuto:
    The instrument automatically goes to the most sensitiveavailable range to measure the applied signal.
- resistanceAuto:
    The instrument automatically goes to the most sensitivea vailable range to measure the applied signal.
- chargeAuto:
    The instrument automatically goes to the most sensitivea vailable range to measure the applied signal.
- chargeAutoGroup:
    The instrument only autoranges between two groups. HIGH ranges between 2C and 20C. LOW ranges between 20nC and 200nC
- medianFilterRank:
    See manual, it’s too long to fit here
- sqsMode:
    Upon start-up, set measurement mode to current, do zero correction, set slow rate

Release History
1.1.0-2.11.4

Created: | 2021-09-29T11:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | Compatible with Karabo 2.11.x Polling interval is configurable.

1.1.0-2.11.4-rc2

Created: | 2021-09-29T10:01:27.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.11.4-rc1

Created: | 2021-09-27T09:43:12.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.0.2-2.10.0

Created: | 2020-12-02T18:23:46.000+01:00
Author: | Riccardo Fabbri
Notes: | Add Karabo 2.10 Versioning Info

1.0.1-2.5.1

Created: | 2019-08-20T16:41:31.000+02:00
Author: | Cyril Danilevski
Notes: | Fix value reading

1.0.0-2.5.1

Created: | 2019-08-05T15:55:32.000+02:00
Author: | Cyril Danilevski
Notes: | First implementation

### A23

#### HIDG

##### CAM

###### CAM_1

Instance id: | HED_A23_HIDG/CAM/CAM_1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
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: | main_A23, HED_A23_HIDG/CAM/CAM_1|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_2

Instance id: | HED_A23_HIDG/CAM/CAM_2
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
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: | main_A23, HED_A23_HIDG/CAM/CAM_2|scene, PAM_CAM, BCC_CAM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_3

Instance id: | HED_A23_HIDG/CAM/CAM_3
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | HED_A23_HIDG/CAM/CAM_3|scene
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### CAM_4

Instance id: | HED_A23_HIDG/CAM/CAM_4
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
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_A23_HIDG/CAM/CAM_4|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_5

Instance id: | HED_A23_HIDG/CAM/CAM_5
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
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: | main_A23, HED_A23_HIDG/CAM/CAM_5|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_6

Instance id: | HED_A23_HIDG/CAM/CAM_6
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
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: | main_A23, HED_A23_HIDG/CAM/CAM_6|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### PROC

[add component documentation]

###### CAM_3

Instance id: | HED_A23_HIDG/PROC/CAM_3
Class id: | ImageProcessor
Host: | exflcon185
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-23
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’, ‘hedonc’]!

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.

##### CORR

[add component documentation]

###### CAM_3

Instance id: | HED_A23_HIDG/CORR/CAM_3
Class id: | AutoCorrelator
Host: | hed-rr-sys-con-23
Alias: | hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/karaboDevices/autoCorrelator
Last modified: | 2021-08-03T17:04:22.000+02:00
Created at: | 2017-01-18T17:29:30.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 2.3.7-2.11.1
Deployment tag: | 2.3.7-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Auto Correlator

The `AutoCorrelator` device is documented in autoCorrelator: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, 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
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- delay:
    Delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calculate calibration constant from two input images.
- reset:
    Acknowledge error.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.

Release History
2.3.7-2.11.1

Created: | 2021-08-03T17:05:54.000+02:00
Author: | Andrea Parenti
Notes: | Summary: update imageProcessing to 2.5.0-2.11.1.

2.3.6-2.10.0

Created: | 2020-12-01T11:01:48.000+01:00
Author: | Gabriele Giovanetti
Notes: | updated dependencies

2.3.5-2.9.8

Created: | 2020-11-19T11:09:16.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

2.3.5-2.10.0

Created: | 2020-11-19T11:09:16.000+01:00
Author: | Andrea Parenti
Notes: | Same as 2.3.5-2.9.8

2.3.4-2.7.2

Created: | 2020-03-03T13:06:01.000+01:00
Author: | Andrea Parenti
Notes: | Update test platforms + DEPENDS

2.3.3-2.7.0

Created: | 2019-12-20T16:22:43.000+01:00
Author: | Riccardo Fabbri
Notes: | Added initial documentation

2.3.2-2.7.0

Created: | 2019-12-20T15:37:18.000+01:00
Author: | Riccardo Fabbri
Notes: | Added option for pedestal subtraction

2.3.1-2.7.0

Created: | 2019-12-20T11:37:04.000+01:00
Author: | Riccardo Fabbri
Notes: | Bug/Fix corrected in the FWHM extraction

2.3.0-2.7.0

Created: | 2019-12-19T12:46:35.000+01:00
Author: | Andrea Parenti
Notes: | Use NoFSM Code refactoring

2.2.4-2.6.1

Created: | 2019-12-17T13:59:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Added to output channel the visualization of fit results

2.2.3-2.4.0

Created: | 2019-03-28T16:16:38.000+01:00
Author: | Riccardo Fabbri
Notes: | dependency on imageProcessing updated

2.2.2-2.2.1

Created: | 2018-01-26T15:45:55.000+01:00
Author: | Gabriele Giovanetti
Notes: |

2.2.1-2.2.1

Created: | 2018-01-18T12:07:56.000+01:00
Author: | Gabriele Giovanetti
Notes: | updated DEPENDS to latest imageProcessing tag

2.2.0-2.1

Created: | 2017-08-04T12:16:35.000+02:00
Author: | Andrea Parenti
Notes: | Add shape factor for gaussian and sech^2 beam shape.

2.1.0-2.1

Created: | 2017-07-25T11:22:20.000+02:00
Author: | Andrea Parenti
Notes: | DAQ compatible

2.0.0-2.1

Created: | 2017-03-24T14:00:48.000+01:00
Author: | Andrea Parenti
Notes: | Tag for WP78 installation

1.2.0-1.4

Created: | 2016-07-22T09:33:13.000+00:00
Author: | Andrea Parenti
Notes: | Package autoCorrelator got tagged from “branches/1.2-1.4” to “tags/1.2.0-1.4” via karabo script

1.0.0-1.1

Created: | 2014-09-18T09:29:41.000+00:00
Author: | Majank Kumar
Notes: | creating tags/1.0.0-1.1

1.0.0

Created: | 2014-05-21T08:45:03.000+00:00
Author: | Majank Kumar
Notes: | creating tagged release 1.0.0

### ATT

#### OPT

##### TSENS

###### ARM1_T1

Instance id: | HED_ATT_OPT/TSENS/ARM1_T1
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### ARM1_T2

Instance id: | HED_ATT_OPT/TSENS/ARM1_T2
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM2_T1

Instance id: | HED_ATT_OPT/TSENS/ARM2_T1
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM2_T2

Instance id: | HED_ATT_OPT/TSENS/ARM2_T2
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM3_T1

Instance id: | HED_ATT_OPT/TSENS/ARM3_T1
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM3_T2

Instance id: | HED_ATT_OPT/TSENS/ARM3_T2
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM4_T1

Instance id: | HED_ATT_OPT/TSENS/ARM4_T1
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### ARM4_T2

Instance id: | HED_ATT_OPT/TSENS/ARM4_T2
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### B4C_T1

Instance id: | HED_ATT_OPT/TSENS/B4C_T1
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

###### B4C_T2

Instance id: | HED_ATT_OPT/TSENS/B4C_T2
Class id: | BeckhoffAnalogInput
Host: | exflcon151
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.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’, ‘hedonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

### DAQ

#### DATA

##### DA

###### 1

Instance id: | HED_DAQ_DATA/DA/1
Class id: | DataAggregator
Host: | hed-br-sys-daq-da1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/DA/2
Class id: | DataAggregator
Host: | hed-br-sys-daq-da1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/DA/3
Class id: | DataAggregator
Host: | hed-br-sys-daq-da2
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/DA/4
Class id: | DataAggregator
Host: | hed-br-sys-daq-da2
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: |

###### 5

Instance id: | HED_DAQ_DATA/DA/5
Class id: | DataAggregator
Host: | hed-br-sys-daq-da1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: |

###### 6

Instance id: | HED_DAQ_DATA/DA/6
Class id: | DataAggregator
Host: | hed-br-sys-daq-da1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: |

###### 7

Instance id: | HED_DAQ_DATA/DA/7
Class id: | DataAggregator
Host: | hed-br-sys-daq-da2
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: |

###### 8

Instance id: | HED_DAQ_DATA/DA/8
Class id: | DataAggregator
Host: | hed-br-sys-daq-da2
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/DM/CONFIGURATOR
Class id: | RunConfigurator
Host: | hed-br-sys-daq-srv1
Alias: | hed-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, HED_RUN_CONTROL_GLOBAL_STATE, HED_DAQ_DATA/DM/CONFIGURATOR|scene, HED_RUN_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: | HED_DAQ_DATA/DM/DATA_MANAGER
Class id: | DataManager
Host: | hed-br-sys-daq-srv1
Alias: | hed-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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Resets the device in case of an error
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- instrumentsList:
    List of instruments for this DAQ instance (e.g FXE,SA1)!
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runNumber:
    Current run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### DSG_CHECK

Instance id: | HED_DAQ_DATA/DM/DSG_CHECK
Class id: | CheckConfigGroups
Host: | hed-br-sys-daq-dsg1
Alias: | hed-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’, ‘hedonc’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- availableGroups:
    Avialable groups
- scanGroupsResult:
    Scan Results
- configuratorId:
    DAQ CONFIGURATOR device Id
- timeServerId:
    A timeServerId to get a trainId
- recentTrainId:
    Most recently published train ID from timeServer
- trainIdThreshold:
    Threshold for trainId
- checkTrainIdFrom:
    Return TrainId from device slot/configuration

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### DSG_REPORT

Instance id: | HED_DAQ_DATA/DM/DSG_REPORT
Class id: | ReportConfigGroups
Host: | hed-br-sys-daq-dsg1
Alias: | hed-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’, ‘hedonc’]!

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

###### HDR_PSC_CAM_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_PSC_CAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HDR_PSC_CAM_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_PSC_CAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HDR_PSC_CAM_3_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_PSC_CAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HDR_PSC_CAM_4_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_PSC_CAM_4_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HDR_PSC_CAM_5_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_PSC_CAM_5_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_ACA2440_CAMS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_ACA2440_CAMS_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_DOOCS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_DOOCS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_IBS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_IBS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_PSC_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_PSC_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_SAM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_SAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_EXP_TELESCOPES_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_TELESCOPES_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_EXP_VAREX_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_VAREX_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_VAREX_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_VAREX_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_ZYLA_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_ZYLA_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_ZYLA_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_ZYLA_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_HAMAMATSU_STREAK_CAMERA_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_HAMAMATSU_STREAK_CAMERA_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_HPLAS_HIL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_HPLAS_HIL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_DETM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_DETM_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_EPIX100-1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX100-1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_EPIX100-2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX100-2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_EPIX10K_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX10K_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_EPIX10K_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX10K_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_EPIX10K_3_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX10K_3_GROUP
Host: | exflcon92n0
Alias: | sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-02-19T18:04:57.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

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

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### HED_IA1_JNGFR-1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JNGFR-1_GROUP
Host: | exflcon92n0
Alias: | sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-02-19T18:04:57.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

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

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### HED_IA1_JNGFR-2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JNGFR-2_GROUP
Host: | exflcon92n0
Alias: | sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-02-19T18:04:57.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

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

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### HED_IA2_FASTADC_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA2_FASTADC_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IC2_SAM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IC2_SAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_LAS_COM_CAMS_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_LAS_COM_CAMS_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_LAS_COM_CAMS_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_LAS_COM_CAMS_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_LH_CAM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_LH_CAM_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_OPT_IPM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_OPT_IPM_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T18:34:35.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: | HED_DAQ_DATA/DM/HED_OPT_IPM_GROUP|scene
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_OPT_MOTOR_DELAY_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_OPT_MOTOR_DELAY_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_SCANGROUP_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_SCANGROUP_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_TUNNEL_CAMERAS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_TUNNEL_CAMERAS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### IPM_BIU_HRMONO_IMGPI_GROUP

Instance id: | HED_DAQ_DATA/DM/IPM_BIU_HRMONO_IMGPI_GROUP
Host: | exflcon92n0
Alias: | sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-02-19T18:04:57.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

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

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### MDC_REMOTE

Instance id: | HED_DAQ_DATA/DM/MDC_REMOTE
Class id: | MetadataDBRemote
Host: | hed-br-sys-daq-srv1
Alias: | hed-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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### RUN_CONTROL

Instance id: | HED_DAQ_DATA/DM/RUN_CONTROL
Class id: | RunController
Host: | hed-br-sys-daq-srv1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_HPLAS_HIL/Shot_scene, HED_RUN_CONTROL_NEW_Colorblind2, HED_SPECTATOR_MAIN, APP_EXP_2710/ScanSample, APP_HED_EXP_MAIN/Shutdown, Check_list, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new, AGIPD500K2G-Control_new_jsd, HED_HPLAS_HIL/Shot_scene0, HED_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, HED_RUN_CONTROL_GLOBAL_STATE, HED_DAQ_DATA/DM/RUN_CONTROL_COMPONENT|scene, HED_SPECTATOR_MAIN, HED_HPLAS_HIL/Shot_scene_old, APP_EXP_2586/scanSample, APP_EXP_2586/scanSample, APP_EXP_2586/scanSampleVertical, HED_SPECTATOR_MAIN_exp_2586, HED_RUN_CONTROL_GLOBAL_STATE, APP_EXP_2738_SPECTATOR, APP_2738_SPECTATOR_MAIN, ScanSample_XYZ_ver2, ScanSample_XYZ, ScanSample_XYZ_from2586, ScanSample_fixedZ, APP2656/rasterScan
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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_XTD1_ATT_GROUP

Instance id: | HED_DAQ_DATA/DM/SA2_XTD1_ATT_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD1_CRL_1_PART_1_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD1_CRL_1_PART_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD1_CRL_1_PART_2_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD1_CRL_1_PART_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD6_CRL_2_PART_1_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD6_CRL_2_PART_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD6_CRL_2_PART_2_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD6_CRL_2_PART_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD6_MIRRORS_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD6_MIRRORS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD6_PBLM_MONO_1_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD6_PBLM_MONO_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### XTD6_PBLM_MONO_2_HR_GROUP

Instance id: | HED_DAQ_DATA/DM/XTD6_PBLM_MONO_2_HR_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_DETM_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_DETM_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HDR_CAM_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HED_EXP_PIXIS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_PIXIS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_LT_CAM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_LT_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_A23_HIDG_CAMS_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_A23_HIDG_CAMS_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_A23_HIDG_CAMS_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_A23_HIDG_CAMS_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-29T11:38:32.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_EXP_HIDG_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_HIDG_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_HIDG_3_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_3_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_HIDG_4_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_4_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_HIDG_5_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_5_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_EXP_HIDG_6_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_EXP_HIDG_6_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HDR_CAM_TEST_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_TEST_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HED_IA1_EPIX100-3_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_EPIX100-3_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_1_CTRL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_1_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_2_CTRL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_2_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_3_CTRL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_3_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_3_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_3_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_4_CTRL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_4_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_IA1_JF500K_4_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_IA1_JF500K_4_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_PP_TIMING_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_PP_TIMING_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_PAM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_PAM_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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_XTD_BEAM_IMAGERS_GROUP

Instance id: | HED_DAQ_DATA/DM/SA2_XTD_BEAM_IMAGERS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HIREX_BRAGG_GROUP

Instance id: | HED_DAQ_DATA/DM/HIREX_BRAGG_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HIREX_GOTTHARD_GROUP

Instance id: | HED_DAQ_DATA/DM/HIREX_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HIREX_MOTOR_GROUP

Instance id: | HED_DAQ_DATA/DM/HIREX_MOTOR_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### AGIPD500K2G_XTDF_GROUP

Instance id: | HED_DAQ_DATA/DM/AGIPD500K2G_XTDF_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### AGIPD500K2G_CTRL_PWR_GROUP

Instance id: | HED_DAQ_DATA/DM/AGIPD500K2G_CTRL_PWR_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### DOOCS_BAM_GROUP

Instance id: | HED_DAQ_DATA/DM/DOOCS_BAM_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_AGIPD500K2G_TSYS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_AGIPD500K2G_TSYS_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T18:34:35.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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

###### HED_LT_MOT_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_LT_MOT_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HDR_CAM_2_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HDR_CAM_3_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_3_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HDR_CAM_4_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_4_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HDR_CAM_5_GROUP

Instance id: | HED_DAQ_DATA/DM/HDR_CAM_5_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-06-30T16:09:40.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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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

###### HED_A23_CAMS1_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_A23_CAMS1_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_A23_CAMS2_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_A23_CAMS2_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_HAM_STREAK_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_HAM_STREAK_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_DOC_ADHOC_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_OPT_IPM_XGM_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_OPT_IPM_XGM_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### LASER_STABILITY_GROUP

Instance id: | HED_DAQ_DATA/DM/LASER_STABILITY_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### CNRS_SPEC_GROUP

Instance id: | HED_DAQ_DATA/DM/CNRS_SPEC_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_2738_SAMP_XYZ_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_2738_SAMP_XYZ_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_CRL4_NFS_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_CRL4_NFS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_OPTIQUE_PETER_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_OPTIQUE_PETER_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_PAM_BEAM_POINTING_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_PAM_BEAM_POINTING_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_PAM_SPATIAL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_PAM_SPATIAL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_PAM_SPECTRAL_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_PAM_SPECTRAL_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### HED_X2TIMER_GROUP

Instance id: | HED_DAQ_DATA/DM/HED_X2TIMER_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### IC2_MOTORS_GROUP

Instance id: | HED_DAQ_DATA/DM/IC2_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### KEITHLEY_GROUP

Instance id: | HED_DAQ_DATA/DM/KEITHLEY_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### MDC_POLLER

###### POLARIMETRY_MOTORS_GROUP

Instance id: | HED_DAQ_DATA/DM/POLARIMETRY_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### PPU_TRIGGER_GROUP

Instance id: | HED_DAQ_DATA/DM/PPU_TRIGGER_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

###### ZYLA_HF_GROUP

Instance id: | HED_DAQ_DATA/DM/ZYLA_HF_GROUP
Class id: | RunConfigurationGroup
Host: | hed-br-sys-daq-dsg1
Alias: | hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T15:40:18.389+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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed 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: |

##### EPIX

###### 1

Instance id: | HED_DAQ_DATA/EPIX/1
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/EPIX/2
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_DAQ_STATUS-OBSOLETE, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/EPIX/3
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/EPIX/4
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: |

###### 5

Instance id: | HED_DAQ_DATA/EPIX/5
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/JNGFR/1
Class id: | DataAggregator
Host: | hed-br-sys-daq-da4
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/JNGFR/2
Class id: | DataAggregator
Host: | hed-br-sys-daq-da4
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/JNGFR/3
Class id: | DataAggregator
Host: | hed-br-sys-daq-da4
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/JNGFR/4
Class id: | DataAggregator
Host: | hed-br-sys-daq-da4
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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: | HED_DAQ_DATA/JNGFRCTRL/0
Class id: | DataAggregator
Host: | hed-br-sys-daq-da3
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_RUN_CONTROL, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind2, HED_RUN_CONTROL_NEW, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW_Colorblind, HED_RUN_CONTROL_NEW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

##### AGIPD500K2GCTRL

[add component documentation]

###### 0

Instance id: | HED_DAQ_DATA/AGIPD500K2GCTRL/0
Class id: | DataAggregator
Host: | hed-br-sys-daq-da1
Alias: | hed-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: | HED_RUN_CONTROL_NEW-OBSOLETE, HED_DAQ_STATUS-OBSOLETE, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, HED_DAQ_STATUS, HED_RUN_CONTROL_NEW, AGIPD500K2G-Control_new, AGIPD500K2G-Control_new_jsd
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### DOC

[add component documentation]

###### 1

Instance id: | HED_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | hed-br-sys-daq-da4
Alias: | hed-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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

### DETB

#### AGIPD1M

##### ACTRL

###### PRI_CHL

Instance id: | HED_DETB_AGIPD1M/ACTRL/PRI_CHL
Class id: | BeckhoffChiller
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### ASENS

###### PRI_CHL

Instance id: | HED_DETB_AGIPD1M/ASENS/PRI_CHL
Class id: | BeckhoffChiller
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### DCTRL

###### PRI_CHL

Instance id: | HED_DETB_AGIPD1M/DCTRL/PRI_CHL
Class id: | BeckhoffChiller
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SWITCH

###### PRI_CHL

Instance id: | HED_DETB_AGIPD1M/SWITCH/PRI_CHL
Class id: | BeckhoffChiller
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffChiller
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### BIAS

##### MCPS

###### DETLVHV

Instance id: | HED_DETB_BIAS/MCPS/DETLVHV
Class id: | Mpod
Host: | hed-rr-sys-con-3
Class documentation:
| Mpod
Alias: | hed-rr-sys-con-3
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: | HED_IA2_IC2, HED_DETB_BIAS/MCPS/DETLVHV|overview, HED_BS_DIODE, HED_BS_DIODE, HED_IC2_I0MON, MPOD_DEVICES, AGIPD_mini_half_power, AGIPD500K2G-Control, AGIPD_mini_half_power, AGIPD500K2G-Control_new, AGIPD500K2G-Control_new_jsd, IBS_DIODES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### IMG

##### BKG

###### ACA2440-1

Instance id: | HED_DETB_IMG/BKG/ACA2440-1
Host: | exflcon137
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-10-23T12:30:42.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.24.2-2.6.1
Installed tag: | 1.23.0-2.5
Accessible by: | CONTROLS, DA

Warning

The installed tag (1.23.0-2.5) does not match tags mentioned in the deployment ([‘1.24.2-2.6.1’])!

###### Image Background Subtraction

The `ImageBackgroundSubtraction` device is part of the imageProcessor package, and is documented in imageprocessor:image-background-user

##### CAM

###### ACA2440-1

Instance id: | HED_DETB_IMG/CAM/ACA2440-1
Host: | exflcon137
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2019-10-22T13:44:59.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Giovanetti
Latest tag: | 5.5.10-2.6.2
Deployment tag: | 5.5.5-2.5.0
Installed tag: | 5.5.5-2.5.0
Accessible by: | CONTROLS, DA

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

###### ACA2440-1

Instance id: | HED_DETB_IMG/PROC/ACA2440-1
Host: | exflcon137
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-10-23T12:30:42.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.24.2-2.6.1
Installed tag: | 1.23.0-2.5
Accessible by: | CONTROLS, DA

Warning

The installed tag (1.23.0-2.5) does not match tags mentioned in the deployment ([‘1.24.2-2.6.1’])!

###### Image Processor

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

#### MOV

##### MOTOR

###### AGIPD_X

###### AGIPD_Y

###### DB_Z

###### DET_SPARE_1

###### DET_SPARE_2

###### DET_SPARE_3

###### DET_SPARE_4

###### DET_SPARE_5

###### DPLAT_X

###### DPLAT_Y

##### MDL

[add component documentation]

###### ZYLA_ATT

Instance id: | HED_DETB_MOV/MDL/ZYLA_ATT
Class id: | BeamImagingUnit
Host: | hed-rr-sys-con-1
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_HPLAS_HIL/Shot_scene0, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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
- moveSi200:
    Moves the motor to the position marked with this label
- moveSi100Al90:
    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: |

#### GPTRIG

[add component documentation]

##### 1

Instance id: | HED_DETB_GPTRIG_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | ZYLA_COM_Aug20200, APP_HED-FLEX/Main, ZYLA5_OptPeter_TWexp, ZYLA5_OptPeter_BGsubtracted_averaged_, ZYLA5_OP_PAMcamera0, ZYLA5_OP_PAMcamera, Optique_Peter, Zyla_HF
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### 2

Instance id: | HED_DETB_GPTRIG_2
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### 3

Instance id: | HED_DETB_GPTRIG_3
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

### HPLAS

#### HET

##### VALVE

###### HE_DV_01

Instance id: | HED_HPLAS_HET/VALVE/HE_DV_01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_DV_02

Instance id: | HED_HPLAS_HET/VALVE/HE_DV_02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_DV_03

Instance id: | HED_HPLAS_HET/VALVE/HE_DV_03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_DV_04

Instance id: | HED_HPLAS_HET/VALVE/HE_DV_04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DIPOLE_PPU

Instance id: | HED_HPLAS_HET/VALVE/DIPOLE_PPU
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

##### DCTRL

[add component documentation]

###### DIPOLE_PPU

Instance id: | HED_HPLAS_HET/DCTRL/DIPOLE_PPU
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

[add component documentation]

###### INT_ALIGN_MODE

Instance id: | HED_HPLAS_HET/SWITCH/INT_ALIGN_MODE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INT_KW_MODE

Instance id: | HED_HPLAS_HET/SWITCH/INT_KW_MODE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INT_SHOT_MODE

Instance id: | HED_HPLAS_HET/SWITCH/INT_SHOT_MODE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### AMP_100J_T

Instance id: | HED_HPLAS_HET/TSENS/AMP_100J_T
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AMP_10J_T

Instance id: | HED_HPLAS_HET/TSENS/AMP_10J_T
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PREAMP_T

Instance id: | HED_HPLAS_HET/TSENS/PREAMP_T
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SEEDER_T

Instance id: | HED_HPLAS_HET/TSENS/SEEDER_T
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HEVAC

##### PUMP

###### HE_VPS_01

###### HE_VPS_02

##### TPUMP

###### HE_VPT_01

Instance id: | HED_HPLAS_HEVAC/TPUMP/HE_VPT_01
Host: | exflcon154
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HE_VPT_02

Instance id: | HED_HPLAS_HEVAC/TPUMP/HE_VPT_02
Host: | exflcon154
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### SPARE_TP1

Instance id: | HED_HPLAS_HEVAC/TPUMP/SPARE_TP1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_TP2

Instance id: | HED_HPLAS_HEVAC/TPUMP/SPARE_TP2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_VVF_01

Instance id: | HED_HPLAS_HEVAC/VALVE/HE_VVF_01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_VVF_02

Instance id: | HED_HPLAS_HEVAC/VALVE/HE_VVF_02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_VVS_03

Instance id: | HED_HPLAS_HEVAC/VALVE/HE_VVS_03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HE_VVS_04

Instance id: | HED_HPLAS_HEVAC/VALVE/HE_VVS_04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_GV1

Instance id: | HED_HPLAS_HEVAC/VALVE/SPARE_GV1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_GV2

Instance id: | HED_HPLAS_HEVAC/VALVE/SPARE_GV2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HIL

##### DOOCS

###### PHASESHIFTER

Instance id: | HED_HPLAS_HIL/DOOCS/PHASESHIFTER
Class id: | DoocsPhaseshifter
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | Phaseshifter, HED_HPLAS_HIL/RelaxTiming, HED_HPLAS_HIL/RelaxTimingExpert, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.13-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
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- lockStatus:
    O: Locked, 1: NOT locked, Other: UnknownThe value larger than 1 might indicate switching of the PP laser synchronisation mode between RF and optical
- lock:
    Lock the laser by setting the coarseTune to ID: 3
- unlock:
    Unlock the laser by setting the coarseTune to ID: 7
- move:
    Move to target time shift.
- stop:
    Stop time shifting with the phase shifter.
- coarseTune:
    lock the laser (close fast loop in the firmware) command id: 6 - unlock the laser (open fast loop) command id: 7- tune laser to operation point and lock it: 3 - tune laser to operation point but do not lock it: 1 - stop tuning action: 2
- updateInterval:
    Update interval.

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

###### OPTICALDELAY

Instance id: | HED_HPLAS_HIL/DOOCS/OPTICALDELAY
Class id: | DoocsOpticalDelay
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | HED_HPLAS_HIL/RelaxTiming, HED_HPLAS_HIL/RelaxTimingExpert, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.13-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
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- move:
    Move to target optical delay
- stop:
    Stop time shifting with the optical delay.
- isSWLimitHigh:
    Dummy property requires for scan tool
- isSWLimitLow:
    Dummy property requires for scan tool
- isCWLimit:
    Dummy property requires for scan tool
- isCCWLimit:
    Dummy property requires for scan tool
- updateInterval:
    Update interval.
- lockStatus:
    O: Locked - 1: NOT locked - 3: Unknown

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

##### TR_HI_FE

Instance id: | HED_HPLAS_HIL/TR_HI_FE
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_HPLAS_HIL/RelaxTimingExpert
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### TR_HI_MA

Instance id: | HED_HPLAS_HIL/TR_HI_MA
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_HPLAS_HIL/RelaxTimingExpert
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### TR_MS

Instance id: | HED_HPLAS_HIL/TR_MS
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_HPLAS_HIL/RelaxTimingExpert, HED_HPLAS_HIL_OVERVIEW, COMP_SHOT_ON_DEMAND/HIL_Trigger
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### TR_PC

Instance id: | HED_HPLAS_HIL/TR_PC
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_HPLAS_HIL/RelaxTimingExpert, HED_HPLAS_HIL_OVERVIEW, COMP_SHOT_ON_DEMAND/HIL_Trigger
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### DCTRL

[add component documentation]

###### UTCA_DIGITALOUT1

###### UTCA_DIGITALOUT2

###### UTCA_OVERRIDE

Instance id: | HED_HPLAS_HIL/DCTRL/UTCA_OVERRIDE
Class id: | BeckhoffDigitalOutput
Host: | exflcon162
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | HED_HPLAS_HIL/RelaxTiming, HED_HPLAS_HIL_OVERVIEW, COMP_SHOT_ON_DEMAND/Simple, HED_HPLAS_HIL/Shot_scene, HED_HPLAS_HIL/Shot_scene0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

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

##### PROC

[add component documentation]

###### EXECUTE_CONFIG

###### EXECUTE_ONTRAIN1

###### EXECUTE_ONTRAIN2

##### SWITCH

[add component documentation]

###### UTCA_DIGITALIN1

Instance id: | HED_HPLAS_HIL/SWITCH/UTCA_DIGITALIN1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### HIT

##### MOTOR

###### HI_DV_01

###### HI_DV_02

###### HI_DV_03

###### HI_DV_04

###### HI_DV_05

###### HI_OM_04_TRANS

###### SPARE_1

##### VALVE

###### HI_DV_06

Instance id: | HED_HPLAS_HIT/VALVE/HI_DV_06
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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]

###### MAIN_COMPR_FF

Instance id: | HED_HPLAS_HIT/CAM/MAIN_COMPR_FF
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | MAIN_COMP_FF, APP_HED_EXP_MAIN/Shutdown, A23_Comp_Cam
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### MAIN_COMPR_NF

Instance id: | HED_HPLAS_HIT/CAM/MAIN_COMPR_NF
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-23
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | MAIN_COMP_NF, APP_HED_EXP_MAIN/Shutdown, A23_Comp_Cam
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

#### HIVAC

##### GAUGE

###### HI_VMG_01

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_02

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_04

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_07

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_07
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_08

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_08
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HED_HPLAS_HIVAC/GAUGE/HI_VMG_08|scene, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VMG_10

Instance id: | HED_HPLAS_HIVAC/GAUGE/HI_VMG_10
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PUMP

###### HI_VPS_01

###### HI_VPS_02

###### HI_VPS_03

##### TPUMP

###### HI_VPT_01

Instance id: | HED_HPLAS_HIVAC/TPUMP/HI_VPT_01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VPT_02

Instance id: | HED_HPLAS_HIVAC/TPUMP/HI_VPT_02
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VPT_03

Instance id: | HED_HPLAS_HIVAC/TPUMP/HI_VPT_03
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_01_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_01_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_01_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_01_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_01_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_01_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_02_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_02_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_02_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_02_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_02_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_02_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_03_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_03_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_03_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_03_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_03_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_03_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_04_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_04_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_04_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_04_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_04_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_04_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_05_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_05_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_05_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_05_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_05_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_05_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_06_COIL

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_06_COIL
Host: | exflcon154
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### HI_VVF_06_LG

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_06_LG
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVF_06_LO

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVF_06_LO
Host: | exflcon154
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-3
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

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### HI_VVS_01

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_02

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_03

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_04

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_05

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_06

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_06
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_07

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_07
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_08

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_08
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_09

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_09
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_10

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_10
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_11

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_11
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, TMP, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVS_12

Instance id: | HED_HPLAS_HIVAC/VALVE/HI_VVS_12
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HI-LAS-VAC, HI-LAS-VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### DCTRL

###### HI_VVF_01_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_01_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_02_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_02_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_03_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_03_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_04_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_04_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_05_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_05_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_06_COIL

Instance id: | HED_HPLAS_HIVAC/DCTRL/HI_VVF_06_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_01_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_01_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_01_SPARE

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_01_SPARE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_02_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_02_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_02_SPARE

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_02_SPARE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_03_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_03_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_03_SPARE

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_03_SPARE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_04_LG

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_04_LG
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_04_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_04_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_05_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_05_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_05_SPARE

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_05_SPARE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_06_ON

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_06_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HI_VVF_06_SPARE

Instance id: | HED_HPLAS_HIVAC/SWITCH/HI_VVF_06_SPARE
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### IA1

#### DETM

##### MOTOR

###### AXIS_01

Instance id: | HED_IA1_DETM/MOTOR/AXIS_01
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_01_DET_1_X
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_02

Instance id: | HED_IA1_DETM/MOTOR/AXIS_02
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_02_DET_1_Y, HED_IA1_DETM/MOTOR/AXIS_02_DEFOCUS_Z
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_03

Instance id: | HED_IA1_DETM/MOTOR/AXIS_03
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_03_DET_1_Z, HED_IA1_DETM/MOTOR/AXIS_03_DEFOCUS_X
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_04

Instance id: | HED_IA1_DETM/MOTOR/AXIS_04
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_04_DET_1_X, HED_IA1_DETM/MOTOR/AXIS_04_DEFOCUS_Y, HED_IA1_DETM/MOTOR/AXIS_04_SI_ATT
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_05

Instance id: | HED_IA1_DETM/MOTOR/AXIS_05
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_05_SI_ATT, HED_IA1_DETM/MOTOR/AXIS_05_SI_FILTER
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_06

Instance id: | HED_IA1_DETM/MOTOR/AXIS_06
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_06|motorScene, HED_IA1_DETM/MOTOR/AXIS_06|motorScene, CheckForMotors0ff
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_07

Instance id: | HED_IA1_DETM/MOTOR/AXIS_07
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_07_SAM_Z, HED_IA1_DETM/MOTOR/AXIS_07_ONFOCUS_Z
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_08

Instance id: | HED_IA1_DETM/MOTOR/AXIS_08
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_08_SAM_X, SAX, HED_IA1_DETM/MOTOR/AXIS_08|simpleMotorScene, complete, HED_IA1_DETM/MOTOR/AXIS_08_ONFOCUS_X
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_09

Instance id: | HED_IA1_DETM/MOTOR/AXIS_09
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/AXIS_09_SAM_Y, HED_IA1_DETM/MOTOR/AXIS_09_SPARE_1, HED_IA1_DETM/MOTOR/AXIS_09_ONFOCUS_Y
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_10

###### AXIS_11

###### AXIS_12

###### AXIS_13

###### AXIS_14

###### AXIS_15

###### AXIS_16

###### AXIS_17

###### AXIS_18

###### AXIS_19

###### AXIS_20

###### AXIS_21

###### AXIS_22

###### LC_AXIS_01

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_01
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/LC_AXIS_01|motorScene
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### LC_AXIS_02

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_02
Class id: | BeckhoffMC2Base
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-27T10:52:38.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.16-2.9.1
Deployment tag: | 4.3.16-2.9.1
Scenes: | HED_IA1_DETM/MOTOR/LC_AXIS_02_RONCHI_ROT
Accessible by: |

Warning

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

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

###### LC_AXIS_03

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_03
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SAX, HED_IA1_DETM/MOTOR/LC_AXIS_03|simpleMotorScene, complete, HED_IA1_DETM/MOTOR/LC_AXIS_03|motorScene, HED_IA1_DETM/MOTOR/LC_AXIS_03_CRL_ROT
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### LC_AXIS_04

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_04
Class id: | BeckhoffMC2Base
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-03T12:44:57.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
Scenes: | HED_IA1_DETM/MOTOR/LC_AXIS_04|motorScene, SAX, HED_IA1_DETM/MOTOR/LC_AXIS_04|simpleMotorScene
Accessible by: |

Warning

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

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

###### LC_AXIS_05

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_05
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | HED_IA1_DETM/MOTOR/LC_AXIS_05_SI_ATT
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### LC_AXIS_06

Instance id: | HED_IA1_DETM/MOTOR/LC_AXIS_06
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### AXIS_3

###### AXIS_4

###### AXIS_5

###### AXIS_6

###### AXIS_7

###### AXIS_8

###### AXIS_9

###### LC_AXIS_1

###### LC_AXIS_2

###### LC_AXIS_3

###### LC_AXIS_4

###### LC_AXIS_5

###### LC_AXIS_6

##### SWITCH

###### COLLISION_1

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | VH_operation, HED_IA1_DETM/SWITCH/COLLISION_1|scene, VH_operation
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_2

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_3

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_4

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_5

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_6

Instance id: | HED_IA1_DETM/SWITCH/COLLISION_6
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_1

Instance id: | HED_IA1_DETM/TSENS/TEMP_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_10

Instance id: | HED_IA1_DETM/TSENS/TEMP_10
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_2

Instance id: | HED_IA1_DETM/TSENS/TEMP_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_3

Instance id: | HED_IA1_DETM/TSENS/TEMP_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_4

Instance id: | HED_IA1_DETM/TSENS/TEMP_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_5

Instance id: | HED_IA1_DETM/TSENS/TEMP_5
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_6

Instance id: | HED_IA1_DETM/TSENS/TEMP_6
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_7

Instance id: | HED_IA1_DETM/TSENS/TEMP_7
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_8

Instance id: | HED_IA1_DETM/TSENS/TEMP_8
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_9

Instance id: | HED_IA1_DETM/TSENS/TEMP_9
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PMOTOR

[add component documentation]

###### PIEZO_20

##### Motor

[add component documentation]

###### axis_2

Instance id: | HED_IA1_DETM/Motor/axis_2
Class id: | BeckhoffMC2Base
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-10-13T18:13:41.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Teichmann, Rfabbri
Latest tag: | 4.3.19-2.9.8
Deployment tag: | 4.3.19-2.9.8
Accessible by: |

Warning

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

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

Release History
4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

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

##### MON

[add component documentation]

###### FUSE_AXES_17_22

###### FUSE_AXES_1_6

###### FUSE_AXES_7_16

###### FUSE_LC_AXES

#### EPIX100

##### 1

###### DAQ

Instance id: | HED_IA1_EPIX100_1_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_IA1_EPIX100_1_DAQ|overview, EPIX100-1_TRIGGER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

Instance id: | HED_IA1_EPIX100_1_RUN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_IA1_EPIX100_1_RUN|overview, EPIX100-1_TRIGGER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### 2

###### DAQ

Instance id: | HED_IA1_EPIX100_2_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | EPIX100-2_TriggerSetup
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

Instance id: | HED_IA1_EPIX100_2_RUN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | EPIX100-2_TriggerSetup
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### EPIX10K

##### 1

###### DAQ

Instance id: | HED_IA1_EPIX10K_1_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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

Instance id: | HED_IA1_EPIX10K_1_RUN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### 2

###### DAQ

Instance id: | HED_IA1_EPIX10K_2_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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

Instance id: | HED_IA1_EPIX10K_2_RUN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### 3

###### DAQ

Instance id: | HED_IA1_EPIX10K_3_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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

Instance id: | HED_IA1_EPIX10K_3_RUN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### EPX100-1

##### AVG

###### CORR_RECEIVER

Instance id: | HED_IA1_EPX100-1/AVG/CORR_RECEIVER
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Scenes: | EPIX100_AVG
Accessible by: | CONTROLS, DA

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### CAL

###### CORR_GAIN

Instance id: | HED_IA1_EPX100-1/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionEpix100
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: | EPIX100-1_DETCONTROL, EPIX100-1_DETCONTROL, HED_SPECTATOR_MAIN
Accessible by: |

Warning

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

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

###### CORR_OFFSET

Instance id: | HED_IA1_EPX100-1/CAL/CORR_OFFSET
Class id: | OffsetCorrectionEpix
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: | EPIX-1-DETCONTROL-IN-MID, test, EPIX100-1_DETCONTROL, EPIX-1-DETCONTROL, EPIX100-1_DETCONTROL, ALL_DET_VIEW_CAL, ALL_DET_CTRL, EPIX100-1_CALVIEW, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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: | HED_IA1_EPX100-1/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | EPIX100-1_DETCONTROL_OLD, ALL_DET_CTRL_old, ALL_DET_CTRL, ALL_DET_CTRL_2716, EPIX_MAIN, EPX100-1_CONTROL, APP_HED_DETS/backgroundCorrection
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: | HED_IA1_EPX100-1/DET/CONTROL
Class id: | EPix100aControl
Host: | hed-rr-sys-con-13
Alias: | hed-rr-sys-con-13
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-temporary_in_MID, EPIX-1-DETCONTROL-IN-MID, EPIX100-1_DETCONTROL, EPIX-temporary, EPIX-1-DETCONTROL, EPIX100-1_DETCONTROL_OLD, ALL_DET_CTRL_old, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL, ALL_DET_CTRL_2716, EPIX_MAIN, EPX100-1_CONTROL, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, klackova, 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: | HED_IA1_EPX100-1/DET/RECEIVER
Class id: | EPixReceiver
Host: | exflcon183
Alias: | hed-rr-sys-con-13
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-temporary_in_MID, EPIX-1-DETCONTROL-IN-MID, TempMonitor, EPIX100-1_DETCONTROL, EPIX-temporary, EPIX-1-DETCONTROL, EPIX100-1_DETCONTROL, ALL_DET_VIEW_RAW, ALL_DET_CTRL, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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

##### PROC

###### CORR_RECEIVER

Instance id: | HED_IA1_EPX100-1/PROC/CORR_RECEIVER
Host: | exflcon183
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### ZEROMQ

[add component documentation]

###### EPIX100-1

Instance id: | HED_IA1_EPX100-1/ZEROMQ/EPIX100-1
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | la2-br-kc-comp-4 , sa2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.2.4-2.10.0

Created: | 2020-11-18T10:03:59.000Z
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T17:59:22.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T16:23:38.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T11:23:45.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

##### BSUB

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPX100-1/BSUB/RECEIVER
Class id: | ImageBackgroundSubtraction
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

##### TCTRL

[add component documentation]

###### TED4015_PI-1

#### EPX100-2

##### AVG

###### CORR_RECEIVER

Instance id: | HED_IA1_EPX100-2/AVG/CORR_RECEIVER
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Scenes: | EPIX100_AVG
Accessible by: | CONTROLS, DA

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### CAL

###### CORR_GAIN

Instance id: | HED_IA1_EPX100-2/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionEpix100
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-10-21T15:56:21.000+02: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: | EPIX100-2_DETCONTROL, EPIX100-2_DETCONTROL
Accessible by: |

Warning

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

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

###### CORR_OFFSET

Instance id: | HED_IA1_EPX100-2/CAL/CORR_OFFSET
Class id: | OffsetCorrectionEpix
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-10-21T15:56:21.000+02: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-DETCONTROL-IN-MID, EPIX100-2_DETCONTROL, EPIX-2-DETCONTROL, EPIX100-2_DETCONTROL, ALL_DET_VIEW_CAL, ALL_DET_CTRL, EPIX100-2_CalView, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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: | HED_IA1_EPX100-2/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | EPIX100-2_DETCONTROL, ALL_DET_CTRL_old, ALL_DET_CTRL, ALL_DET_CTRL_2716, EPIX_MAIN, EP2, EPX100-2_CONTROL, APP_HED_DETS/backgroundCorrection
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: | HED_IA1_EPX100-2/DET/CONTROL
Class id: | EPix100aControl
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixControl
Last modified: | 2020-03-13T16:29:42.000+01:00
Created at: | 2017-02-14T12:01:16.000+01:00
Main authors: | Hauf, Parenti, Xctrl
Latest tag: | 1.0.1-2.3.7
Deployment tag: | 1.0.1-2.3.7
Scenes: | EPIX-2-DETCONTROL-IN-MID, EPIX100-2_DETCONTROL, EPIX-2-DETCONTROL, EPIX100-2_DETCONTROL, ALL_DET_CTRL, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.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: | HED_IA1_EPX100-2/DET/RECEIVER
Class id: | EPixReceiver
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixReceiver
Last modified: | 2020-02-13T13:47:45.000+01:00
Created at: | 2017-02-14T12:02:02.000+01:00
Main authors: | Parenti, Mekinda, Brockhauser
Latest tag: | 1.0.1-2.6.1-test
Deployment tag: | 1.0.1-2.6.1-test
Scenes: | EPIX-2-temporary-in-MID, EPIX-2-DETCONTROL-IN-MID, TempMonitor, EPIX100-2_DETCONTROL, EPIX-2-temporary, EPIX-2-DETCONTROL, EPIX100-2_DETCONTROL, ALL_DET_VIEW_RAW, ALL_DET_CTRL, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.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

##### PROC

###### CORR_RECEIVER

Instance id: | HED_IA1_EPX100-2/PROC/CORR_RECEIVER
Host: | exflcon183
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### ZEROMQ

[add component documentation]

###### EPIX100-2

Instance id: | HED_IA1_EPX100-2/ZEROMQ/EPIX100-2
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | la2-br-kc-comp-4 , sa2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.2.4-2.10.0

Created: | 2020-11-18T10:03:59.000Z
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T17:59:22.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T16:23:38.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T11:23:45.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

##### BSUB

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPX100-2/BSUB/RECEIVER
Class id: | ImageBackgroundSubtraction
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

##### TCTRL

[add component documentation]

###### TED4015_PI-2

#### EPX100

##### CAL

###### MANAGER

Instance id: | HED_IA1_EPX100/CAL/MANAGER
Class id: | CalManager
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-09-08T12:00:52.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Karnevskiy, Ahmed
Latest tag: | 1.15.3-2.9.1
Deployment tag: | 1.15.3-2.9.1
Scenes: | EPIX-1-DETCONTROL-IN-MID, EPIX-2-DETCONTROL-IN-MID, EPIX100-2_DETCONTROL, EPIX100-1_DETCONTROL, EPIX-1-DETCONTROL, EPIX-2-DETCONTROL, EPIX100-1_DETCONTROL, EPIX100-2_DETCONTROL, EPIX100-3_DETCONTROL
Accessible by: |

Warning

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

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

Release History
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: |

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

#### EPX1001

##### ASENS

###### LV_ANALOG

Instance id: | HED_IA1_EPX1001/ASENS/LV_ANALOG
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_DIGITAL

Instance id: | HED_IA1_EPX1001/ASENS/LV_DIGITAL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_EPX1001/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_EPX1001/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_EPX1001/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### EPX1002

##### ASENS

###### LV_ANALOG

Instance id: | HED_IA1_EPX1002/ASENS/LV_ANALOG
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_DIGITAL

Instance id: | HED_IA1_EPX1002/ASENS/LV_DIGITAL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_EPX1002/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_BIAS/DCTRL/LV_ILOCK_01|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_EPX1002/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_EPX1002/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### EPX10K-1

##### ASENS

###### LV_ANALOG

Instance id: | HED_IA1_EPX10K-1/ASENS/LV_ANALOG
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_DIGITAL

Instance id: | HED_IA1_EPX10K-1/ASENS/LV_DIGITAL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_EPX10K-1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_EPX10K-1/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_EPX10K-1/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### EPX10K-2

##### ASENS

###### LV_ANALOG

Instance id: | HED_IA1_EPX10K-2/ASENS/LV_ANALOG
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_DIGITAL

Instance id: | HED_IA1_EPX10K-2/ASENS/LV_DIGITAL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_EPX10K-2/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_EPX10K-2/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_EPX10K-2/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### EPX10K-3

##### ASENS

###### LV_ANALOG

Instance id: | HED_IA1_EPX10K-3/ASENS/LV_ANALOG
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_DIGITAL

Instance id: | HED_IA1_EPX10K-3/ASENS/LV_DIGITAL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_EPX10K-3/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_EPX10K-3/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_EPX10K-3/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### FSSS

##### MOTOR

###### SCAN_CLAMP

###### SCAN_X

###### SCAN_Y

##### SWITCH

###### TRIG_1

Instance id: | HED_IA1_FSSS/SWITCH/TRIG_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TRIG_2

Instance id: | HED_IA1_FSSS/SWITCH/TRIG_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### ENC

[add component documentation]

###### SCAN_X

Instance id: | HED_IA1_FSSS/ENC/SCAN_X
Class id: | BeckhoffEncoder
Host: | exflcon152
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-24T13:44:35.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.0-2.10.0
Deployment tag: | 4.4.0-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- 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.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

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.

###### SCAN_Y

Instance id: | HED_IA1_FSSS/ENC/SCAN_Y
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-24T13:44:35.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.0-2.10.0
Deployment tag: | 4.4.0-2.10.0
Accessible by: |

Warning

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

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

Release History
4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

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.

#### IC

##### BKG

###### ACA2440-1

Instance id: | HED_IA1_IC/BKG/ACA2440-1
Class id: | ImageBackgroundSubtraction
Host: | exflcon137
Alias: | hed-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’, ‘hedonc’]!

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.

###### ACA2440-2

Instance id: | HED_IA1_IC/BKG/ACA2440-2
Host: | exflcon137
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-10-23T12:30:42.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.24.2-2.6.1
Installed tag: | 1.23.0-2.5
Accessible by: | CONTROLS, DA

Warning

The installed tag (1.23.0-2.5) does not match tags mentioned in the deployment ([‘1.24.2-2.6.1’])!

###### Image Background Subtraction

The `ImageBackgroundSubtraction` device is part of the imageProcessor package, and is documented in imageprocessor:image-background-user

##### CAM

###### ACA2440-1

Instance id: | HED_IA1_IC/CAM/ACA2440-1
Class id: | LimaBaslerCamera
Host: | exflcon137
Class documentation:
| LimaBaslerCamera
Alias: | hed-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: | HED_IA1_IC/CAM/ACA2440-1|scene
Accessible by: |

Warning

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

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

###### ACA2440-2

Instance id: | HED_IA1_IC/CAM/ACA2440-2
Host: | exflcon137
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2019-10-22T13:44:59.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Giovanetti
Latest tag: | 5.5.10-2.6.2
Deployment tag: | 5.5.5-2.5.0
Installed tag: | 5.5.5-2.5.0
Scenes: | HED_IA1_IC/CAM/ACA2440-2|scene
Accessible by: | CONTROLS, DA

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

###### CAM-1

Instance id: | HED_IA1_IC/CAM/CAM-1
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2020-03-24T14:11:51.000+01:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Kirienko, Goeries
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: | HED_IA1_IC/CAM/CAM-1|scene
Accessible by: | CONTROLS, DA

[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

###### FISHEYE_VIEW

Instance id: | HED_IA1_IC/CAM/FISHEYE_VIEW
Class id: | LimaBaslerCamera
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
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: | HED_IA1_IC/CAM/FISHEYE_VIEW|scene, HED_IA1_IC-CAM-FISHEYE_VIEW-scene, HED_IA1_ILM/inlineCamAveragView
Accessible by: |

Warning

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

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

##### DCTRL

###### CAM_1

Instance id: | HED_IA1_IC/DCTRL/CAM_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM_2

Instance id: | HED_IA1_IC/DCTRL/CAM_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM_3

Instance id: | HED_IA1_IC/DCTRL/CAM_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM_4

Instance id: | HED_IA1_IC/DCTRL/CAM_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HBB_R

###### VBB_R1

###### VBB_R2

###### VBB_R3A

###### VBB_R3B

###### VBB_X

##### PROC

###### ACA2440-1

Instance id: | HED_IA1_IC/PROC/ACA2440-1
Class id: | ImageProcessor
Host: | exflcon137
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

###### ACA2440-2

Instance id: | HED_IA1_IC/PROC/ACA2440-2
Host: | exflcon137
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-10-23T12:30:42.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.24.2-2.6.1
Installed tag: | 1.23.0-2.5
Accessible by: | CONTROLS, DA

Warning

The installed tag (1.23.0-2.5) does not match tags mentioned in the deployment ([‘1.24.2-2.6.1’])!

###### Image Processor

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

###### FISHEYE_VIEW

Instance id: | HED_IA1_IC/PROC/FISHEYE_VIEW
Class id: | ImageProcessor
Host: | exflcon137
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

##### TSENS

###### VBB_R1

Instance id: | HED_IA1_IC/TSENS/VBB_R1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### VBB_R2

Instance id: | HED_IA1_IC/TSENS/VBB_R2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### VBB_R3A

Instance id: | HED_IA1_IC/TSENS/VBB_R3A
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### VBB_R3B

Instance id: | HED_IA1_IC/TSENS/VBB_R3B
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### VBB_X

Instance id: | HED_IA1_IC/TSENS/VBB_X
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### AVE

[add component documentation]

###### FISHEYE_VIEW

Instance id: | HED_IA1_IC/AVE/FISHEYE_VIEW
Class id: | ImageAverager
Host: | exflcon137
Alias: | hed-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: | HED_IA1_ILM/inlineCamAveragView
Accessible by: |

Warning

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

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.

##### BCG

[add component documentation]

###### FISHEYE_VIEW

Instance id: | HED_IA1_IC/BCG/FISHEYE_VIEW
Class id: | ImageBackgroundSubtraction
Host: | exflcon137
Alias: | hed-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’, ‘hedonc’]!

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.

##### BGC

[add component documentation]

###### FISHEYE_VIEW

Instance id: | HED_IA1_IC/BGC/FISHEYE_VIEW
Class id: | ImageBackgroundSubtraction
Host: | exflcon137
Alias: | hed-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: | HED_IA1_ILM/inlineCamAveragView, ILM_2716
Accessible by: |

Warning

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

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.

#### ILM

##### DCTRL

###### CAM

Instance id: | HED_IA1_ILM/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_ILM/inlineCamAveragView
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LED

##### MOTOR

###### MIC_AX

###### MIC_AY

###### MIC_X

###### MIC_Y

###### MIC_Z

##### ENC

[add component documentation]

###### MIC_AX

Instance id: | HED_IA1_ILM/ENC/MIC_AX
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### MIC_AY

Instance id: | HED_IA1_ILM/ENC/MIC_AY
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### MIC_X

Instance id: | HED_IA1_ILM/ENC/MIC_X
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### MIC_Y

Instance id: | HED_IA1_ILM/ENC/MIC_Y
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### MIC_Z

Instance id: | HED_IA1_ILM/ENC/MIC_Z
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### AVE

[add component documentation]

###### MICROSCOPE

Instance id: | HED_IA1_ILM/AVE/MICROSCOPE
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_ILM/inlineCamAveragView
Accessible by: |

Warning

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

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]

###### MICROSCOPE

Instance id: | HED_IA1_ILM/CAM/MICROSCOPE
Class id: | LimaBaslerCamera
Host: | exflcon165
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-11
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: | HED_IA1_ILM/CAM/MICROSCOPE|scene, HED_IA1_ILM/inlineCamAveragView
Accessible by: |

Warning

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

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]

###### MICROSCOPE

Instance id: | HED_IA1_ILM/PROC/MICROSCOPE
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_IA1_ILM/inlineCamProc
Accessible by: |

Warning

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

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.

##### BKG

[add component documentation]

###### MICROSCOPE

Instance id: | HED_IA1_ILM/BKG/MICROSCOPE
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_ILM/inlineCamAveragView
Accessible by: |

Warning

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

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.

##### MDL

[add component documentation]

###### FILTERPOS

Instance id: | HED_IA1_ILM/MDL/FILTERPOS
Class id: | BeamImagingUnit
Host: | hed-rr-sys-con-1
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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
- moveFiltered:
    Moves the motor to the position marked with this label
- moveFree:
    Moves the motor to the position marked with this label
- moveBlocked:
    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: |

#### JNGFR-1

##### CAL

###### DARK_CHAR

Instance id: | HED_IA1_JNGFR-1/CAL/DARK_CHAR
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2019-11-04T15:03:02.000+01:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Hauf, Xctrl, Ahmed
Latest tag: | 1.1.4-2.6.0-hotfix@SPB
Deployment tag: | 1.1.4-2.6.0-hotfix@SPB
Installed tag: | None
Scenes: | JNGFR-1_CONTROL
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=80 days, 5:44:00!

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘1.1.4-2.6.0-hotfix@SPB’])!

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

##### DET

###### CONTROL

Instance id: | HED_IA1_JNGFR-1/DET/CONTROL
Host: | exflcon186
Class documentation:
| JungfrauControl
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2019-12-17T08:57:03.000+01:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.0rc1-2.7.0
Deployment tag: | 1.6.1-2.6.5
Scenes: | JNGFR-1_CONTROL, JUNGFRAU_2, complete, JNGFR-2_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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.

Release History
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: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

###### MODULE

Instance id: | HED_IA1_JNGFR-1/DET/MODULE
Host: | exflcon186
Class documentation:
| JungfrauReceiver
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2019-12-17T08:57:03.000+01:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.0rc1-2.7.0
Deployment tag: | 1.6.1-2.6.5
Scenes: | JNGFR-1_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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.

Release History
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: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

##### MATCHER

###### RECEIVER

Instance id: | HED_IA1_JNGFR-1/MATCHER/RECEIVER
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
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: | None
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=20 days, 2:56:00!

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘0.2.1-2.5.0’])!

##### ZEROMQ

###### RECEIVER

Instance id: | HED_IA1_JNGFR-1/ZEROMQ/RECEIVER
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2019-10-01T11:30:43.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat
Latest tag: | 2.5.2-2.6.1
Deployment tag: | 2.5.2-2.6.1
Installed tag: | 2.5.1-2.4.0
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.5.1-2.4.0) does not match tags mentioned in the deployment ([‘2.5.2-2.6.1’])!

#### JNGFR-2

##### CAL

###### CORR_GAIN

Instance id: | HED_IA1_JNGFR-2/CAL/CORR_GAIN
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-02-14T16:08:21.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.3-2.7.0
Deployment tag: | 1.11.3-2.7.0
Scenes: | JUNGFRAU_2, complete, JNGFR-2_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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

Release History
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: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET

Instance id: | HED_IA1_JNGFR-2/CAL/CORR_OFFSET
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-02-14T16:08:21.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.3-2.7.0
Deployment tag: | 1.11.3-2.7.0
Scenes: | JUNGFRAU_2, complete, JNGFR-2_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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

Release History
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: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

###### MANAGER

Instance id: | HED_IA1_JNGFR-2/CAL/MANAGER
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-02-14T16:08:21.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.3-2.7.0
Deployment tag: | 1.11.3-2.7.0
Scenes: | JUNGFRAU_2, JNGFR-2_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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

Release History
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: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

##### DET

###### CONFIG

Instance id: | HED_IA1_JNGFR-2/DET/CONFIG
Host: | exflcon186
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2019-11-04T15:03:02.000+01:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Hauf, Xctrl, Ahmed
Latest tag: | 1.1.4-2.6.0-hotfix@SPB
Deployment tag: | 1.1.4-2.6.0-hotfix@SPB
Installed tag: | 1.1.2-2.6.0-test
Scenes: | JNGFR-2_CONTROL
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.1.2-2.6.0-test) does not match tags mentioned in the deployment ([‘1.1.4-2.6.0-hotfix@SPB’])!

###### MODULE

Instance id: | HED_IA1_JNGFR-2/DET/MODULE
Host: | exflcon186
Class documentation:
| JungfrauReceiver
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2019-12-17T08:57:03.000+01:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.0rc1-2.7.0
Deployment tag: | 1.6.1-2.6.5
Scenes: | JUNGFRAU_2, complete, JNGFR-2_CONTROL
Accessible by: |

Warning

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

[add instance documentation]

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.

Release History
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: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

#### JNGFR

##### CAL

###### MANAGER

Instance id: | HED_IA1_JNGFR/CAL/MANAGER
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2019-11-04T14:51:10.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Hauf, Kamil
Latest tag: | 1.10.3-2.6.1
Deployment tag: | 1.10.3-2.6.1
Installed tag: | None
Scenes: | JNGFR-1_CONTROL
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=80 days, 5:45:00!

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘1.10.3-2.6.1’])!

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

##### 1

###### DAQ

Instance id: | HED_IA1_JNGFR_1_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_IA1_JNGFR_1_DAQ|overview, JF500K1_TRIGGER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### 2

###### DAQ

Instance id: | HED_IA1_JNGFR_2_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | JF500K2_TRIGGER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### 3

###### DAQ

Instance id: | HED_IA1_JNGFR_3_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_IA1_JNGFR_3_DAQ|overview, JF500K3_TRIGGER_IA1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### 4

###### DAQ

Instance id: | HED_IA1_JNGFR_4_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### JNGFR1

##### ASENS

###### LV_SENS

Instance id: | HED_IA1_JNGFR1/ASENS/LV_SENS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_JNGFR1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | JUNGFRAU_POWER, HED_IA1_JNGFR1/TSENS/T1|scene, ch201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_JNGFR1/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_JNGFR1/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### JNGFR2

##### ASENS

###### LV_SENS

Instance id: | HED_IA1_JNGFR2/ASENS/LV_SENS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_JNGFR2/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | JUNGFRAU_POWER, ch201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_JNGFR2/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_JNGFR2/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### JNGFR3

##### ASENS

###### LV_SENS

Instance id: | HED_IA1_JNGFR3/ASENS/LV_SENS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_JNGFR3/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_JNGFR3/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_JNGFR3/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### JNGFR4

##### ASENS

###### LV_SENS

Instance id: | HED_IA1_JNGFR4/ASENS/LV_SENS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T1

Instance id: | HED_IA1_JNGFR4/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T2

Instance id: | HED_IA1_JNGFR4/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T3

Instance id: | HED_IA1_JNGFR4/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### LT

##### CAM

###### CAM_1

Instance id: | HED_IA1_LT/CAM/CAM_1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_IA1_LT/CAM/CAM_1_and_20, HED_IA1_LT/CAM/CAM_1|scene, HED_IA1_IC-CAM-FISHEYE_VIEW-scene, HED_IA1_LT-CAM-CAM_1_and_20, HED_IA1_LT-CAM-CAM_1-scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_2

Instance id: | HED_IA1_LT/CAM/CAM_2
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_IA1_LT/CAM/CAM_1_and_20, HED_IA1_LT/CAM/CAM_2|scene, HED_IA1_LT/CAM/CAM_2_AVG, Align_ILM, HED_IA1_FSI_CAMERAS, HED_IA1_LASER_ALIGNMENT, HED_IA1_LT/CAM2_AVG_BKG, HED_STATUS_OVERVIEW, HED_IA1_LT-CAM-CAM_1_and_20, HED_IA1_LT-CAM-CAM_2-scene, HED_IA1_LT-CAM2_AVG_BKG, HED_STATUS_OVERVIEW, HED_IA1_ILM/ILM_Camera
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### CAM_2_AVG

Instance id: | HED_IA1_LT/CAM/CAM_2_AVG
Host: | exflcon165
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Scenes: | HED_IA1_LT/CAM/CAM_2|scene, HED_IA1_LT/CAM/CAM_2_AVG
Accessible by: | CONTROLS, DA

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

###### FSI

GENICAM CAMERAS

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

###### CAM_3

Instance id: | HED_IA1_LT/CAM/CAM_3
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_IA1_LASER_ALIGNMENT, HED_IA1_LT/AverageViewCam3, HED_IA1_LT/CAM/CAM_3_AVG_BKG, Temp_LT_CAM_3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### DCTRL

###### CAM_1

Instance id: | HED_IA1_LT/DCTRL/CAM_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_IC/CAM/FISHEYE_VIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM_2

Instance id: | HED_IA1_LT/DCTRL/CAM_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_LT/CAM2_AVG_BKG, HED_IA1_LT-CAM2_AVG_BKG, HED_IA1_ILM/ILM_Camera
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM_3

Instance id: | HED_IA1_LT/DCTRL/CAM_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_FSI_MAIN, HED_IA1_FSI/CAM_AVG_BKG, HED_IA1_LT/AverageViewCam3, HED_IA1_LT/CAM/CAM_3_AVG_BKG
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DIAG_1_X

###### DIAG_1_Y

###### DIAG_1_Z

###### DIAG_2_X

###### DIAG_2_Y

###### DIAG_2_Z

###### HE_FOC_1

###### HE_FOC_2

###### HE_MIRR_1_Z

###### HE_MIRR_2_Z

###### HI_MIRR_1_X

###### HI_MIRR_1_Y

###### HI_MIRR_1_Z

###### HI_MIRR_2_X

###### HI_MIRR_2_Y

###### HI_MIRR_2_Z

###### OAP_AX

###### OAP_AY

###### OAP_AZ

###### OAP_X

###### OAP_Y

###### OAP_Z

###### PP_VISAR_IMG_1_X

###### PP_VISAR_IMG_1_Y

###### PP_VISAR_IMG_1_Z

###### PP_VISAR_IMG_2_X

###### PP_VISAR_IMG_2_Y

###### PP_VISAR_IMG_2_Z

###### SPARE_1

###### SPARE_2

###### SPARE_3

###### SPARE_4

###### SPARE_5

###### SPARE_6

###### SPARE_7

###### SPARE_8

##### PROC

###### ScanToolLineout

Instance id: | HED_IA1_LT/PROC/ScanToolLineout
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-10-23T12:30:42.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.24.2-2.6.1
Installed tag: | 1.23.0-2.5
Accessible by: | CONTROLS, DA

Warning

The installed tag (1.23.0-2.5) does not match tags mentioned in the deployment ([‘1.24.2-2.6.1’])!

###### Image Processor

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

###### CAM_2

Instance id: | HED_IA1_LT/PROC/CAM_2
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/CAM_2_proc, HED_IA1_LT-CAM_2_proc
Accessible by: |

Warning

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

Image Processor

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

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

1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### cam_2

Instance id: | HED_IA1_LT/PROC/cam_2
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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’, ‘hedonc’]!

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.

###### CAM_2_PROC2

Instance id: | HED_IA1_LT/PROC/CAM_2_PROC2
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/CAM_2_proc, HED_IA1_LT-CAM_2_proc
Accessible by: |

Warning

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

Image Processor

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

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

1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### CAM_3

Instance id: | HED_IA1_LT/PROC/CAM_3
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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’, ‘hedonc’]!

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.

##### SWITCH

###### COLLISION_1

Instance id: | HED_IA1_LT/SWITCH/COLLISION_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_2

Instance id: | HED_IA1_LT/SWITCH/COLLISION_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_3

Instance id: | HED_IA1_LT/SWITCH/COLLISION_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_4

Instance id: | HED_IA1_LT/SWITCH/COLLISION_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_5

Instance id: | HED_IA1_LT/SWITCH/COLLISION_5
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COLLISION_6

Instance id: | HED_IA1_LT/SWITCH/COLLISION_6
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_1

Instance id: | HED_IA1_LT/TSENS/TEMP_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_10

Instance id: | HED_IA1_LT/TSENS/TEMP_10
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_2

Instance id: | HED_IA1_LT/TSENS/TEMP_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_3

Instance id: | HED_IA1_LT/TSENS/TEMP_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_4

Instance id: | HED_IA1_LT/TSENS/TEMP_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_5

Instance id: | HED_IA1_LT/TSENS/TEMP_5
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_6

Instance id: | HED_IA1_LT/TSENS/TEMP_6
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_7

Instance id: | HED_IA1_LT/TSENS/TEMP_7
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_8

Instance id: | HED_IA1_LT/TSENS/TEMP_8
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TEMP_9

Instance id: | HED_IA1_LT/TSENS/TEMP_9
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### AVG

[add component documentation]

###### CAM_1

Instance id: | HED_IA1_LT/AVG/CAM_1
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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’, ‘hedonc’]!

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_2

Instance id: | HED_IA1_LT/AVG/CAM_2
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/CAM/CAM_2|scene, Align_ILM, HED_IA1_FSI_CAMERAS, HED_IA1_LASER_ALIGNMENT, HED_IA1_LT/CAM2_AVG_BKG, HED_IA1_LT-CAM-CAM_2-scene, HED_IA1_LT-CAM2_AVG_BKG
Accessible by: |

Warning

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

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.

###### FSI

Instance id: | HED_IA1_LT/AVG/FSI
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_FSI_MAIN, HED_IA1_LASER_ALIGNMENT, HED_IA1_FSI/CAM_AVG_BKG
Accessible by: |

Warning

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

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_3

Instance id: | HED_IA1_LT/AVG/CAM_3
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/AverageViewCam3
Accessible by: |

Warning

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

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.

##### ENC

[add component documentation]

###### DIAG_1_X

Instance id: | HED_IA1_LT/ENC/DIAG_1_X
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### DIAG_1_Y

Instance id: | HED_IA1_LT/ENC/DIAG_1_Y
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### DIAG_1_Z

Instance id: | HED_IA1_LT/ENC/DIAG_1_Z
Host: | exflcon177
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T15:44:33.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

The installed tag (None) does not match tags mentioned in the deployment ([‘4.3.10-2.6.1’])!

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### BGS

[add component documentation]

###### FSI

Instance id: | HED_IA1_LT/BGS/FSI
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LASER_ALIGNMENT, HED_IA1_FSI/CAM_AVG_BKG
Accessible by: |

Warning

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

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.

##### BKG

[add component documentation]

###### CAM_2

Instance id: | HED_IA1_LT/BKG/CAM_2
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/CAM2_AVG_BKG, HED_IA1_LT-CAM2_AVG_BKG
Accessible by: |

Warning

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

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.

###### CAM_3

Instance id: | HED_IA1_LT/BKG/CAM_3
Class id: | ImageBackgroundSubtraction
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_LT/AverageViewCam3
Accessible by: |

Warning

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

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.

#### NFS

##### HEXAPOD

###### CRL_HEX_AX

Instance id: | HED_IA1_NFS/HEXAPOD/CRL_HEX_AX
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
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

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.

###### CRL_HEX_AY

Instance id: | HED_IA1_NFS/HEXAPOD/CRL_HEX_AY
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
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

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.

###### CRL_HEX_AZ

Instance id: | HED_IA1_NFS/HEXAPOD/CRL_HEX_AZ
Host: | exflcon177
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-4
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

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.

###### CRL_HEX_X

###### CRL_HEX_Y

###### CRL_HEX_Z

###### CRL_HEX_U

###### CRL_HEX_V

###### CRL_HEX_W

###### MDL

###### ETH

##### MOTOR

###### CRL_X

###### CRL_Z

###### NANOCUBE

Instance id: | HED_IA1_NFS/MOTOR/NANOCUBE
Class id: | BeckhoffGeneric
Host: | hed-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PMOTOR

###### DIODE

Instance id: | HED_IA1_NFS/PMOTOR/DIODE
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PHASE_X

Instance id: | HED_IA1_NFS/PMOTOR/PHASE_X
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_2_AX_PHASE_X, HED_IA1_NFS/PMOTOR/PHASE_X|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PHASE_Y

Instance id: | HED_IA1_NFS/PMOTOR/PHASE_Y
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_2_AY_PHASE_Y, HED_IA1_NFS/PMOTOR/PHASE_Y|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PHASE_Z

Instance id: | HED_IA1_NFS/PMOTOR/PHASE_Z
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/BENTX_ROT_PHASE_Z, BENT_CRYSTAL, HED_IA1_NFS/PMOTOR/PHASE_Z|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIN_X

Instance id: | HED_IA1_NFS/PMOTOR/PIN_X
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_3_AX_PIN_X, HED_IA1_NFS/PMOTOR/PIN_X|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIN_Y

Instance id: | HED_IA1_NFS/PMOTOR/PIN_Y
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_3_AY_PIN_Y, HED_IA1_NFS/PMOTOR/PIN_Y|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIN_Z

Instance id: | HED_IA1_NFS/PMOTOR/PIN_Z
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_3_AX_PIN_Z, HED_IA1_NFS/PMOTOR/PIN_Z|motorScene, main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCAN_X

Instance id: | HED_IA1_NFS/PMOTOR/SCAN_X
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_1_AX_SCAN_X, von_Hamos_spectr
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCAN_Y

Instance id: | HED_IA1_NFS/PMOTOR/SCAN_Y
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_1_AY_SCAN_Y, von_Hamos_spectr, HED_IA1_NFS/PMOTOR/SCAN_Y|simpleMotorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCAN_Z

Instance id: | HED_IA1_NFS/PMOTOR/SCAN_Z
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE

Instance id: | HED_IA1_NFS/PMOTOR/SPARE
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | HED_IA1_NFS/PMOTOR/DCA_3_AY_SPARE, PIEZO__HED_IA1_NFS-PMOTOR-SPARE, APP_HED-FLEX/Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### SAMP

##### MOTOR

###### CRL_HEX_A

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_A
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_A|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### CRL_HEX_B

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_B
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_B|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### CRL_HEX_C

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_C
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_C|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### CRL_HEX_X

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_X
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_X|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### CRL_HEX_Y

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_Y
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_Y|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### CRL_HEX_Z

Instance id: | HED_IA1_SAMP/MOTOR/CRL_HEX_Z
Class id: | BeckhoffMC2Base
Host: | exflcon152
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-09-21T16:17:18.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Rfabbri, Giovanetti
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Scenes: | HED_IA1_SAMP/MOTOR/CRL_HEX_Z|simpleMotorScene, SAMPLE_HEXAPOD
Accessible by: |

Warning

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

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

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

###### SAMP_AY

###### SAMP_Y

###### HEXAPOD_U

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_U
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### HEXAPOD_V

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_V
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### HEXAPOD_W

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_W
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### HEXAPOD_X

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_X
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | move_target_Z, CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### HEXAPOD_Y

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_Y
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

###### HEXAPOD_Z

Instance id: | HED_IA1_SAMP/MOTOR/HEXAPOD_Z
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2021-06-07T08:51:00.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Fabbri, Hauf, Giovanetti
Latest tag: | 4.6.0-2.11.0-rc2
Deployment tag: | 4.6.0-2.11.0-rc2
Installed tag: | 4.4.6-2.10.0-hotfix-01
Scenes: | CheckForMotors0ff
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.4.6-2.10.0-hotfix-01) does not match tags mentioned in the deployment ([‘4.6.0-2.11.0-rc2’])!

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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- 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.

Release History
4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

##### ENC

[add component documentation]

###### SAMP_AY

Instance id: | HED_IA1_SAMP/ENC/SAMP_AY
Class id: | BeckhoffEncoder
Host: | exflcon152
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-24T13:44:35.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.0-2.10.0
Deployment tag: | 4.4.0-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- 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.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

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.

###### SAMP_Y

Instance id: | HED_IA1_SAMP/ENC/SAMP_Y
Host: | exflcon152
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-14T18:44:55.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Accessible by: |

Warning

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

[add instance documentation]

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### MDL

[add component documentation]

###### HEXAPOD

###### HEX_HTTP

#### TSC-1

##### ASENS

###### FOCUS

Instance id: | HED_IA1_TSC-1/ASENS/FOCUS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM

Instance id: | HED_IA1_TSC-1/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | hed_ia1_telescope_1_cam_cam|scene, temporary_front_questar, HED_IA1_TSC-1/AverageView
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FILTER_WHEEL

###### FOCUS

##### AVE

[add component documentation]

###### TARGET_FRONT

Instance id: | HED_IA1_TSC-1/AVE/TARGET_FRONT
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | HED_IA1_FSSS_MAIN, temporary_front_questar, HED_IA1_TSC-1/AverageView, APP_EXP_2716/SampleAlignment, Sample_alignment
Accessible by: |

Warning

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

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]

###### TARGET_FRONT

Instance id: | HED_IA1_TSC-1/CAM/TARGET_FRONT
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_IA1_FSSS_MAIN_old, temporary_front_questar, HED_IA1_FSI_CAMERAS, HED_STATUS_OVERVIEW, HED_SPECTATOR_MAIN, HED_IA1_TSC-1/AverageView, APP_EXP_2716/SampleAlignment, Sample_alignment, HED_SPECTATOR_MAIN, HED_STATUS_OVERVIEW, HED_IA1_TSC-1_CRL-Z_scan, HED_SPECTATOR_MAIN_exp_2586, APP_EXP_2738_SPECTATOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### PROC

[add component documentation]

###### TARGET_FRONT

Instance id: | HED_IA1_TSC-1/PROC/TARGET_FRONT
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_IA1_TSC-1/FrontProc
Accessible by: |

Warning

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

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.

#### TSC-2

##### ASENS

###### FOCUS

Instance id: | HED_IA1_TSC-2/ASENS/FOCUS
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM

Instance id: | HED_IA1_TSC-2/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | hed_ia1_telescope_2_cam_cam|scene, temporary_back_questar, HED_IA1_TSC-2/AverageView, HED_IA1_TSC-2/AverageView
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FILTER_WHEEL

###### FOCUS

##### AVE

[add component documentation]

###### TARGET_BACK

Instance id: | HED_IA1_TSC-2/AVE/TARGET_BACK
Class id: | ImageAverager
Host: | exflcon165
Alias: | hed-rr-sys-con-11
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: | temporary_back_questar, HED_IA1_TSC-2/AverageView, HED_IA1_TSC-2/AverageView
Accessible by: |

Warning

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

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]

###### TARGET_BACK

Instance id: | HED_IA1_TSC-2/CAM/TARGET_BACK
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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_IA1_FSSS_MAIN_old, temporary_back_questar, HED_IA1_FSI_CAMERAS, HED_IA1_LASER_ALIGNMENT, HED_STATUS_OVERVIEW, HED_IA1_TSC-2/AverageView, HED_IA1_TSC-2/AverageView, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### PROC

[add component documentation]

###### TARGET_BACK

Instance id: | HED_IA1_TSC-2/PROC/TARGET_BACK
Class id: | ImageProcessor
Host: | exflcon165
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-11
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: | HED_IA1_TSC-2/TARGET_BACK
Accessible by: |

Warning

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

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.

#### VAC

##### DCTRL

###### IC1_SP01_PUMPS_ON

Instance id: | HED_IA1_VAC/DCTRL/IC1_SP01_PUMPS_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP01_RPUMP_ON

Instance id: | HED_IA1_VAC/DCTRL/IC1_SP01_RPUMP_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_PUMPS_ON

Instance id: | HED_IA1_VAC/DCTRL/IC1_SP02_PUMPS_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_RPUMP_ON

Instance id: | HED_IA1_VAC/DCTRL/IC1_SP02_RPUMP_ON
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV04

Instance id: | HED_IA1_VAC/DCTRL/IC1_VV04
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_HPLAS_HIL/Shot_scene, HED_STATUS_OVERVIEW, HED_IA1_TSC-1/AverageView, HED_HPLAS_HIL/Shot_scene0, HED_STATUS_OVERVIEW, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV05

Instance id: | HED_IA1_VAC/DCTRL/IC1_VV05
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_HPLAS_HIL/Shot_scene, HED_STATUS_OVERVIEW, HED_HPLAS_HIL/Shot_scene0, HED_IA1_TSC-2/AverageView, HED_IA1_TSC-2/AverageView, HED_STATUS_OVERVIEW, HED_HPLAS_HIL/Shot_scene_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GREEN

Instance id: | HED_IA1_VAC/DCTRL/IC1_GREEN
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PUMP_OK

Instance id: | HED_IA1_VAC/DCTRL/IC1_PUMP_OK
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG01

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HI-LAS-VAC, IC1_Druck, HED_IA1_FSSS_MAIN_old, Vacuum_in_time, HED_IA1_VAC/VALVE/IC1_GV03|InterlockOverview, HED_IA1_VAC, HED_EXP_IA1_VAC, HI-LAS-VAC, Comissining_main_scenes, HED_EXP_MAIN, HED_IA1_VAC/VALVE/IC1_GV02|InterlockOverview, ALL_DET_CTRL_old, HED_STATUS_OVERVIEW, JF_MAIN, EPIX_MAIN, EP2, EP3, HED_STATUS_OVERVIEW, Masterview, JF_MAIN, APP_EXP_2738_SPECTATOR, APP_2738_SPECTATOR_MAIN, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG02

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG03

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG04

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_IA1_VAC/VALVE/IC1_GV02|InterlockOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG05

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG05
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC/VALVE/IC1_GV03|InterlockOverview, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG06

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG06
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG07

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG07
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG08

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG08
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG09

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG09
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_PG10

Instance id: | HED_IA1_VAC/GAUGE/IC1_PG10
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SWITCH

###### IC1_SP01_ALARM

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP01_ALARM
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP01_DP_RUNNING

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP01_DP_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP01_PR_RUNNING

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP01_PR_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP01_READY

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP01_READY
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_ALARM

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP02_ALARM
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_DP_RUNNING

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP02_DP_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_PR_RUNNING

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP02_PR_RUNNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_SP02_READY

Instance id: | HED_IA1_VAC/SWITCH/IC1_SP02_READY
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_ILOCK_1

Instance id: | HED_IA1_VAC/SWITCH/IC1_ILOCK_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_ILOCK_2

Instance id: | HED_IA1_VAC/SWITCH/IC1_ILOCK_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TPUMP

###### IC1_TP01

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP02

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP02
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP03

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP03
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP04

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP04
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP05

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP05
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP06

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP06
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP07

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP07
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP08

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP08
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_TP09

Instance id: | HED_IA1_VAC/TPUMP/IC1_TP09
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV01

Instance id: | HED_IA1_VAC/VALVE/IC1_AV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV02

Instance id: | HED_IA1_VAC/VALVE/IC1_AV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV03

Instance id: | HED_IA1_VAC/VALVE/IC1_AV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_IA1_VAC/VALVE/IC1_AV03|scene, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV04

Instance id: | HED_IA1_VAC/VALVE/IC1_AV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV05

Instance id: | HED_IA1_VAC/VALVE/IC1_AV05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV06

Instance id: | HED_IA1_VAC/VALVE/IC1_AV06
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_AV07

Instance id: | HED_IA1_VAC/VALVE/IC1_AV07
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GV01

Instance id: | HED_IA1_VAC/VALVE/IC1_GV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, Comissining_main_scenes, HED_EXP_MAIN, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/Shutdown, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GV02

Instance id: | HED_IA1_VAC/VALVE/IC1_GV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_IA1_VAC/VALVE/IC1_GV02|InterlockOverview, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GV03

Instance id: | HED_IA1_VAC/VALVE/IC1_GV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC/VALVE/IC1_GV03|InterlockOverview, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GV04

Instance id: | HED_IA1_VAC/VALVE/IC1_GV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC, IC2_status, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_GV05

Instance id: | HED_IA1_VAC/VALVE/IC1_GV05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC/VALVE/IC1_GV05|InterlockOverview, HED_IA1_VAC, HED_EXP_IA1_VAC, IC2_status, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV01

Instance id: | HED_IA1_VAC/VALVE/IC1_VV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV02

Instance id: | HED_IA1_VAC/VALVE/IC1_VV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV03

Instance id: | HED_IA1_VAC/VALVE/IC1_VV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV04

Instance id: | HED_IA1_VAC/VALVE/IC1_VV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IC1_VV05

Instance id: | HED_IA1_VAC/VALVE/IC1_VV05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### FSE

##### MOTOR

###### DEBRIS_SHIELD

###### SAMPLE_LIFT

###### SAMPLE_LOCK

###### SAMPLE_ROTATION

###### TRANSFER_RAIL

##### SWITCH

###### EPS_1

Instance id: | HED_IA1_FSE/SWITCH/EPS_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### EPS_2

Instance id: | HED_IA1_FSE/SWITCH/EPS_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### EPS_3

Instance id: | HED_IA1_FSE/SWITCH/EPS_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### EPS_4

Instance id: | HED_IA1_FSE/SWITCH/EPS_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

Instance id: | HED_IA1_FSE/VALVE/VALVE
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### EPIX10K-1

[add component documentation]

##### AVG

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPIX10K-1/AVG/RECEIVER
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Scenes: | EPIX_AVG
Accessible by: | CONTROLS, DA

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### PROC

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPIX10K-1/PROC/RECEIVER
Host: | exflcon183
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

#### EPIX10K-2

[add component documentation]

##### AVG

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPIX10K-2/AVG/RECEIVER
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Scenes: | EPIX_AVG
Accessible by: | CONTROLS, DA

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

##### PROC

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_EPIX10K-2/PROC/RECEIVER
Host: | exflcon183
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2019-12-10T14:06:36.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Schaffer, Giovanetti
Latest tag: | 1.25.0-2.6.2
Deployment tag: | 1.25.0-2.6.2
Installed tag: | 1.25.0-2.6.2
Accessible by: | CONTROLS, DA

[add instance documentation]

Image Processor

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

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

1.12.0-2.2.6

Created: | 2018-12-13T14:37:50.000Z
Author: | Wajid Ehsan
Notes: | Compute sum along x&y limited to ROI given by a user-defined range

#### EPX100-3

[add component documentation]

##### ZEROMQ

[add component documentation]

###### EPIX100-3

Instance id: | HED_IA1_EPX100-3/ZEROMQ/EPIX100-3
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | la2-br-kc-comp-4 , sa2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.2.4-2.10.0

Created: | 2020-11-18T10:03:59.000Z
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T17:59:22.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T16:23:38.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T11:23:45.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

##### CAL

[add component documentation]

###### CORR_OFFSET

Instance id: | HED_IA1_EPX100-3/CAL/CORR_OFFSET
Class id: | OffsetCorrectionEpix
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-09-08T12:00:52.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Karnevskiy, Ahmed
Latest tag: | 1.15.3-2.9.1
Deployment tag: | 1.15.3-2.9.1
Scenes: | EPX100-3BURN_DETCONTROL, EPIX100-3_burn_test, EPIX100-3_DETCONTROL, ALL_DET_VIEW_CAL
Accessible by: |

Warning

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

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

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

###### MANAGER

Instance id: | HED_IA1_EPX100-3/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | EPX100-3BURN_DETCONTROL, EPIX100-3_DETCONTROL, EPIX_MAIN, EP3, EPX100-3_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

##### MATCHER

[add component documentation]

###### EPX100-3

Instance id: | HED_IA1_EPX100-3/MATCHER/EPX100-3
Host: | exflonc28
Alias: | sa2-br-kc-comp-4 , la2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2020-03-03T18:01:47.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
Installed tag: | 1.0.0-2.7.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

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

##### DET

[add component documentation]

###### CONTROL

Instance id: | HED_IA1_EPX100-3/DET/CONTROL
Class id: | EPix100aControl
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixControl
Last modified: | 2020-03-13T16:29:42.000+01:00
Created at: | 2017-02-14T12:01:16.000+01:00
Main authors: | Hauf, Parenti, Xctrl
Latest tag: | 1.0.1-2.3.7
Deployment tag: | 1.0.1-2.3.7
Scenes: | EPX100-3BURN_DETCONTROL, EPIX100-3_DETCONTROL
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.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: | HED_IA1_EPX100-3/DET/RECEIVER
Class id: | EPixReceiver
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ePixReceiver
Last modified: | 2020-02-13T13:47:45.000+01:00
Created at: | 2017-02-14T12:02:02.000+01:00
Main authors: | Parenti, Mekinda, Brockhauser
Latest tag: | 1.0.1-2.6.1-test
Deployment tag: | 1.0.1-2.6.1-test
Scenes: | EPX100-3BURN_DETCONTROL, EPIX100-3_DETCONTROL, ALL_DET_VIEW_RAW
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.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

##### AVG

[add component documentation]

###### CONTROL

Instance id: | HED_IA1_EPX100-3/AVG/CONTROL
Class id: | ImageAverager
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

##### BSUB

[add component documentation]

###### CONTROL

Instance id: | HED_IA1_EPX100-3/BSUB/CONTROL
Class id: | ImageBackgroundSubtraction
Host: | exflcon183
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

##### PROC

[add component documentation]

###### CONTROL

Instance id: | HED_IA1_EPX100-3/PROC/CONTROL
Class id: | ImageProcessor
Host: | exflcon183
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Accessible by: |

Warning

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

Image Processor

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

#### DCA

[add component documentation]

##### PMOTOR

[add component documentation]

###### CRYSTAL_1_AX

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_1_AX
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_1_AY

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_1_AY
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_2_AX

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_2_AX
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_2_AY

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_2_AY
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_3_AX

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_3_AX
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_3_AY

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_3_AY
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_4_AX

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_4_AX
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CRYSTAL_4_AY

Instance id: | HED_IA1_DCA/PMOTOR/CRYSTAL_4_AY
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_1

Instance id: | HED_IA1_DCA/PMOTOR/SPARE_1
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_2

Instance id: | HED_IA1_DCA/PMOTOR/SPARE_2
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-4
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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: | COMP_HED_DETM/MotorOverviewNew, COMP_HED_DETM/DCAMotors
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### IC1

[add component documentation]

##### PMOTOR

[add component documentation]

###### MIRR10_H

###### MIRR10_V

###### MIRR11_H

###### MIRR11_V

###### MIRR12_H

###### MIRR12_V

###### MIRR1_H

###### MIRR1_V

###### MIRR2_H

###### MIRR2_V

###### MIRR3_H

###### MIRR3_V

###### MIRR4_H

###### MIRR4_V

###### MIRR5_H

###### MIRR5_V

###### MIRR6_H

###### MIRR6_V

###### MIRR7_H

###### MIRR7_V

###### MIRR8_H

###### MIRR8_V

###### MIRR9_H

###### MIRR9_V

###### PIEZO_1

###### PIEZO_2

###### PIEZO_3

###### PIEZO_6

#### JF500K1

[add component documentation]

##### CAL

[add component documentation]

###### CORR_GAIN

Instance id: | HED_IA1_JF500K1/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionJungfrau
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: | JF500K-1, JF500K1_CONTROL, JF500K2_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL, ALL_DET_VIEW_CAL, HED_SPECTATOR_MAIN
Accessible by: |

Warning

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

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

###### CORR_OFFSET

Instance id: | HED_IA1_JF500K1/CAL/CORR_OFFSET
Class id: | OffsetCorrectionJungfrau
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: | JF500K-1, JF500K1_CONTROL, JF500K2_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL, ALL_DET_CTRL, HED_SPECTATOR_MAIN, ALL_DET_CTRL
Accessible by: |

Warning

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

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: | HED_IA1_JF500K1/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | JF500K-1, JF500K1_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL, ALL_DET_CTRL_old, HED_STATUS_OVERVIEW, ALL_DET_CTRL, JF_MAIN, JF500K1_CONTROL_old, HED_STATUS_OVERVIEW, JF_MAIN, APP_HED_DETS/backgroundCorrection
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

##### AVG

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K1/AVG/RECEIVER
Class id: | ImageAverager
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF_AVG_K1_K2, JF500K1-DISPLAY, JF500K1-DISPLAY
Accessible by: |

Warning

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

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.

##### BSUB

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K1/BSUB/RECEIVER
Class id: | ImageBackgroundSubtraction
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF500K1-DISPLAY, JF500K1-DISPLAY
Accessible by: |

Warning

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

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.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- 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.

##### DET

[add component documentation]

###### CONFIG

Instance id: | HED_IA1_JF500K1/DET/CONFIG
Class id: | JungfrauConfig
Host: | exflong11
Alias: | sa2-br-sys-daq-rcal-1 , mid-br-sys-cal-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2020-07-24T17:21:34.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-newprocedure
Deployment tag: | 1.2.0-2.8.0-newprocedure
Scenes: | JF500K-1, JF500K1_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL
Accessible by: |

Warning

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

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
- 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
- reset:
    In case of an Error, allow for taking
      different actions through an ACTIVE state

Release History
1.2.0-2.8.0-newprocedure

Created: | 2020-07-21T17:14:42.000Z
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

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: | HED_IA1_JF500K1/DET/CONTROL
Class id: | JungfrauControl
Host: | exflcon186
Class documentation:
| JungfrauControl
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-10-21T16:15:18.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K-1, JF500K1_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL, ALL_DET_CTRL, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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:
    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
- 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.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

###### JNGFR01

Instance id: | HED_IA1_JF500K1/DET/JNGFR01
Class id: | JungfrauReceiver
Host: | exflcon186
Class documentation:
| JungfrauReceiver
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-10-21T16:15:18.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K-1, JF500K1_CONTROL, JF500K1_CONTROL, JF500K1_CONTROL, ALL_DET_VIEW_RAW, ALL_DET_CTRL, ALL_DET_CTRL
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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.
- burstMode:
    The Jungfrau is operated in “burst mode”, namely with external trigger and more than one memory cell.
- storageCellStart:
    First storage cell used by the Jungfrau. It is usually 15.

Release History
1.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

##### PROC

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K1/PROC/RECEIVER
Class id: | ImageProcessor
Host: | exflcon186
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-18
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’, ‘hedonc’]!

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.

##### ZEROMQ

[add component documentation]

###### JF500K1

Instance id: | HED_IA1_JF500K1/ZEROMQ/JF500K1
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | sa2-br-kc-comp-4 , la2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-07-17T18:18:44.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.1.1-2.9.0
Deployment tag: | 3.1.1-2.9.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

###### JF500K2

Instance id: | HED_IA1_JF500K1/ZEROMQ/JF500K2
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | sa2-br-kc-comp-4 , la2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-07-17T18:18:44.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.1.1-2.9.0
Deployment tag: | 3.1.1-2.9.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

###### JF500K3

Instance id: | HED_IA1_JF500K1/ZEROMQ/JF500K3
Class id: | PipeToZeroMQ
Host: | exflonc28
Alias: | la2-br-kc-comp-4 , sa2-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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.
- addressOutput0:
    Address to use to get data from this output
- data_sent0:
    Count total of train data sent on this output

Release History
3.2.4-2.10.0

Created: | 2020-11-18T10:03:59.000Z
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T17:59:22.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T16:23:38.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T11:23:45.000Z
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T08:31:31.000Z
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

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

#### JF500K2

[add component documentation]

##### CAL

[add component documentation]

###### MANAGER

Instance id: | HED_IA1_JF500K2/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | JF500K2_CONTROL, JF500K2_CONTROL_old, ALL_DET_CTRL_old, HED_STATUS_OVERVIEW, ALL_DET_CTRL, ALL_DET_CTRL_2716, JF_MAIN, JF500K2_CONTROL, JF500K2_CONTROLOO, JF500K2_CONTROL, EP2, EP3, HED_STATUS_OVERVIEW, JF_MAIN, APP_HED_DETS/backgroundCorrection
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

###### CORR_GAIN

Instance id: | HED_IA1_JF500K2/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionJungfrau
Host: | exflong11
Alias: | mid-br-sys-cal-9 , sa2-br-sys-daq-rcal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-16T16:29:31.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: | JF500K2_CONTROL, JF500K2_CONTROL, ALL_DET_VIEW_CAL, HED_SPECTATOR_MAIN
Accessible by: |

Warning

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

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

###### CORR_OFFSET

Instance id: | HED_IA1_JF500K2/CAL/CORR_OFFSET
Class id: | OffsetCorrectionJungfrau
Host: | exflong11
Alias: | mid-br-sys-cal-9 , sa2-br-sys-daq-rcal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-16T16:29:31.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: | JF500K2_CONTROL, JF500K2_CONTROL, ALL_DET_CTRL, HED_SPECTATOR_MAIN, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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

##### DET

[add component documentation]

###### CONTROL

Instance id: | HED_IA1_JF500K2/DET/CONTROL
Class id: | JungfrauControl
Host: | exflcon186
Class documentation:
| JungfrauControl
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-10-21T16:15:18.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K2_CONTROL, JF500K2_CONTROL, ALL_DET_CTRL, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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:
    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
- 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.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

###### JNGFR02

Instance id: | HED_IA1_JF500K2/DET/JNGFR02
Class id: | JungfrauReceiver
Host: | exflcon186
Class documentation:
| JungfrauReceiver
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-10-21T16:15:18.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K2_CONTROL, JF500K2_CONTROL, ALL_DET_VIEW_RAW, ALL_DET_CTRL, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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.
- burstMode:
    The Jungfrau is operated in “burst mode”, namely with external trigger and more than one memory cell.
- storageCellStart:
    First storage cell used by the Jungfrau. It is usually 15.

Release History
1.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

##### AVG

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K2/AVG/RECEIVER
Class id: | ImageAverager
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF500K2-DISPLAY, JF_AVG_K1_K2, JF500K2-DISPLAY
Accessible by: |

Warning

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

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.

##### BSUB

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K2/BSUB/RECEIVER
Class id: | ImageBackgroundSubtraction
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF500K2-DISPLAY, JF500K2-DISPLAY
Accessible by: |

Warning

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

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.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- 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.

##### PROC

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K2/PROC/RECEIVER
Class id: | ImageProcessor
Host: | exflcon186
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-18
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: | JF500K2-DISPLAY
Accessible by: |

Warning

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

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.

#### JF500K3

[add component documentation]

##### CAL

[add component documentation]

###### CORR_GAIN

Instance id: | HED_IA1_JF500K3/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionJungfrau
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: | JF500K3_CONTROL, JF500K3_CONTROL
Accessible by: |

Warning

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

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

###### CORR_OFFSET

Instance id: | HED_IA1_JF500K3/CAL/CORR_OFFSET
Class id: | OffsetCorrectionJungfrau
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: | JF500K3_CONTROL, JF500K3_CONTROL, ALL_DET_CTRL, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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: | HED_IA1_JF500K3/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | JF500K3_CONTROL, JF500K3_CONTROL_old, ALL_DET_CTRL_old, HED_STATUS_OVERVIEW, ALL_DET_CTRL, ALL_DET_CTRL_2716, JF_MAIN, JF500K3_CONTROL, JF500K3_CONTROL, EP2, EP3, HED_STATUS_OVERVIEW, JF_MAIN, APP_HED_DETS/backgroundCorrection
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]

###### CONTROL

Instance id: | HED_IA1_JF500K3/DET/CONTROL
Class id: | JungfrauControl
Host: | exflcon186
Class documentation:
| JungfrauControl
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-10-21T16:15:18.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K3_CONTROL, JF500K3_CONTROL, ALL_DET_CTRL, APP_HED_EXP_MAIN/Shutdown, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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:
    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
- 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.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

###### JNGFR03

Instance id: | HED_IA1_JF500K3/DET/JNGFR03
Class id: | JungfrauReceiver
Host: | exflcon186
Class documentation:
| JungfrauReceiver
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-11-12T12:13:27.000+01:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.1-2.9.1
Deployment tag: | 1.8.1-2.9.1
Scenes: | JF500K3_CONTROL, JF500K3_CONTROL, ALL_DET_CTRL, ALL_DET_CTRL, ALL_DET_CTRL_2716
Accessible by: |

Warning

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

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

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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.
- burstMode:
    The Jungfrau is operated in “burst mode”, namely with external trigger and more than one memory cell.
- storageCellStart:
    First storage cell used by the Jungfrau. It is usually 15.

Release History
1.8.1-2.9.1

Created: | 2020-10-06T14:50:12.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T10:44:04.000Z
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-29T12:31:06.000Z
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

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.

###### CONFIG

Instance id: | HED_IA1_JF500K3/DET/CONFIG
Class id: | BeamShapeCoarse
Host: | hed-rr-sys-con-18
Alias: | hed-rr-sys-con-18
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2021-04-16T14:14:01.000+02: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
Installed tag: | 1.27.4-2.10.0
Scenes: | JF500K3_CONTROL, JF500K3_CONTROL_old, JF500K3_CONTROL, JF500K3_CONTROL
Accessible by: | CONTROLS, CTRL, DA, cascella, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Beam Shape Coarse

The `BeamShapeCoarse` device is part of the imageProcessor package, and is documented in imageprocessor:image-beam-shape-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
- x0:
    X coordinate of the maximum intensity pixel.
- y0:
    Y coordinate of the maximum intensity pixel.
- fwhmX:
    Full Width at Half Maximum for X projection, A.K.A. beam width.
- fwhmY:
    Full Width at Half Maximum for Y projection, A.K.A. beam height.
- frameRate:
    Rate of processed images.
- resetError:
    Reset error count.

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.

##### AVG

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K3/AVG/RECEIVER
Class id: | ImageAverager
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF500K3_CONTROL, JF500K3-DISPLAY, JF500K3_DISPLAY
Accessible by: |

Warning

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

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.

##### BSUB

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K3/BSUB/RECEIVER
Class id: | ImageBackgroundSubtraction
Host: | exflcon186
Alias: | hed-rr-sys-con-18
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: | JF500K3-DISPLAY, JF500K3_DISPLAY
Accessible by: |

Warning

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

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.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- 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.

##### PROC

[add component documentation]

###### RECEIVER

Instance id: | HED_IA1_JF500K3/PROC/RECEIVER
Class id: | ImageProcessor
Host: | exflcon186
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-18
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: | JF500K3_CONTROL, JF500K3_DISPLAY
Accessible by: |

Warning

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

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.

##### MDL

[add component documentation]

###### TRIG

#### JF500K4

[add component documentation]

##### CAL

[add component documentation]

###### MANAGER

Instance id: | HED_IA1_JF500K4/CAL/MANAGER
Class id: | CalManager
Host: | hed-br-sys-cal-1
Alias: | hed-br-sys-cal-1
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: | JF500K4_CONTROL, JF500K4_CONTROL, ALL_DET_CTRL_old, ALL_DET_CTRL
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

#### AUX

[add component documentation]

##### SERIAL

[add component documentation]

###### DIODE

###### PHASE_X

###### PHASE_Y

###### PHASE_Z

###### PIN_X

###### PIN_Y

###### PIN_Z

###### SCAN_X

###### SCAN_Y

###### SCAN_Z

###### SPARE

### IA2

#### DAC

##### CAM

###### SAMPLE

Instance id: | HED_IA2_DAC/CAM/SAMPLE
Class id: | LimaBaslerCamera
Host: | exflcon137
Class documentation:
| LimaBaslerCamera
Alias: | hed-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: | HED_IA2_DAC/CAM/SAMPLE|scene, SampleCam
Accessible by: |

Warning

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

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

##### MOTOR

###### CEN_X

###### CEN_Z

###### DAC_ROT

###### DW_FOCUS

###### DW_X

###### DW_Y

###### DW_Z

###### INTEN_MON_1_TRANS

###### INTEN_MON_2_TRANS

###### INTEN_MON_3_TRANS

###### L_DW_X

###### L_DW_Y

###### L_DW_Z

###### L_IODW

###### L_IOUP

###### L_UP_X

###### L_UP_Y

###### L_UP_Z

###### MICRO_X

###### MICRO_Y

###### MICRO_Z

###### NANO_Z

###### OMEGA

###### O_IODW

###### O_IOUP

###### PIN_TILT

###### PIN_X

###### PIN_Y

###### PIN_YAW

###### PIN_Z

###### SAM_X

###### SAM_Y

###### SAM_Z

###### SPARE_STPR_IC2_1

###### SPARE_STPR_IC2_2

###### SPARE_STPR_IC2_3

###### SPARE_STPR_IC2_4

###### UP_FOCUS

###### ZOOM

#### JNGFR-1

##### DAQ

Instance id: | HED_IA2_JNGFR-1_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | ZYLA_2569, ZYLA_2575_DS, ZYLA_2575_US, ZYLA_2575_US, ZYLA_2151_Peter, ZYLA_2151_Taper0, ZYLA2_2151_Peter
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### JNGFR-2

##### DAQ

Instance id: | HED_IA2_JNGFR-2_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### JNGFR-3

##### DAQ

Instance id: | HED_IA2_JNGFR-3_DAQ
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | JF500K3_TRIGGER_IA2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### LH

##### CAM

###### OBSERV_DOWN

Instance id: | HED_IA2_LH/CAM/OBSERV_DOWN
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-6
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-06-28T09:38:49.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.6.10-2.11.1
Deployment tag: | 5.6.10-2.11.1
Scenes: | LH_OBS_DW, OBSERV_CAMERAS
Accessible by: | CONTROLS, CTRL, DA, danilevc, 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.6.10-2.11.1

Created: | 2021-06-11T10:14:55.000Z
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-09T09:54:35.000Z
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### OBSERV_UP

Instance id: | HED_IA2_LH/CAM/OBSERV_UP
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-6
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-06-28T09:38:49.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.6.10-2.11.1
Deployment tag: | 5.6.10-2.11.1
Scenes: | LH_OBS_UP, OBSERV_CAMERAS
Accessible by: | CONTROLS, CTRL, DA, danilevc, 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.6.10-2.11.1

Created: | 2021-06-11T10:14:55.000Z
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-09T09:54:35.000Z
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

#### LHEAT

##### OBSERV_DOWN_TRIG

Instance id: | HED_IA2_LHEAT/OBSERV_DOWN_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### OBSERV_UP_TRIG

Instance id: | HED_IA2_LHEAT/OBSERV_UP_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### STREAK_TRIG

Instance id: | HED_IA2_LHEAT/STREAK_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### DCTRL

###### FILTER_1

Instance id: | HED_IA2_LHEAT/DCTRL/FILTER_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FILTER_2

Instance id: | HED_IA2_LHEAT/DCTRL/FILTER_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ILLUM_1

Instance id: | HED_IA2_LHEAT/DCTRL/ILLUM_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, OBSERV_CAMERAS, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ILLUM_2

Instance id: | HED_IA2_LHEAT/DCTRL/ILLUM_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, OBSERV_CAMERAS, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER_1

Instance id: | HED_IA2_LHEAT/DCTRL/LASER_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER_2

Instance id: | HED_IA2_LHEAT/DCTRL/LASER_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_1

Instance id: | HED_IA2_LHEAT/DCTRL/SPARE_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_EMISSION_GATE

Instance id: | HED_IA2_LHEAT/DCTRL/LASER1_EMISSION_GATE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_EMISSION_GATE

Instance id: | HED_IA2_LHEAT/DCTRL/LASER2_EMISSION_GATE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LED_DW

###### LED_UP

###### SPARE_2

Instance id: | HED_IA2_LHEAT/DCTRL/SPARE_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPECTRO

Instance id: | HED_IA2_LHEAT/DCTRL/SPECTRO
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FESTO_Enable

Instance id: | HED_IA2_LHEAT/DCTRL/FESTO_Enable
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### ACTRL

[add component documentation]

###### LASER1_SETPOWER

Instance id: | HED_IA2_LHEAT/ACTRL/LASER1_SETPOWER
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_SETSIMMER

Instance id: | HED_IA2_LHEAT/ACTRL/LASER1_SETSIMMER
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_SETPOWER

Instance id: | HED_IA2_LHEAT/ACTRL/LASER2_SETPOWER
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_SETSIMMER

Instance id: | HED_IA2_LHEAT/ACTRL/LASER2_SETSIMMER
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### LASER2_WAVEFRONT_7

Instance id: | HED_IA2_LHEAT/LASER2_WAVEFRONT_7
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### ROTATOR_1

###### ROTATOR_2

##### SWITCH

[add component documentation]

###### LASER1_ALARM

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_ALARM
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_BEAM_DELIVERY

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_BEAM_DELIVERY
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_DEACTIVATION

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_DEACTIVATION
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_DISABLE_H

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_DISABLE_H
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_EMISSION_WARNING

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_EMISSION_WARNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_ENABLE

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_IS_ON

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_IS_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_MONITOR

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_MONITOR
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_PULSE_CW

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_PULSE_CW
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_SYSTEM_FAULT

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_SYSTEM_FAULT
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_TEMP

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_TEMP
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_1

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_2

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_3

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_4

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_5

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_5
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_6

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_6
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_7

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_7
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER1_WAVEFRONT_8

Instance id: | HED_IA2_LHEAT/SWITCH/LASER1_WAVEFRONT_8
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_ALARM

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_ALARM
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_BEAM_DELIVERY

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_BEAM_DELIVERY
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_DEACTIVATION

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_DEACTIVATION
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_DISABLE_H

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_DISABLE_H
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_EMISSION_WARNING

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_EMISSION_WARNING
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_ENABLE

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_IS_ON

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_IS_ON
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_MONITOR

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_MONITOR
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_PULSE_CW

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_PULSE_CW
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_SYSTEM_FAULT

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_SYSTEM_FAULT
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_TEMP

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_TEMP
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_WAVEFRONT_1

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_WAVEFRONT_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_WAVEFRONT_3

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_WAVEFRONT_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_WAVEFRONT_5

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_WAVEFRONT_5
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_WAVEFRONT_6

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_WAVEFRONT_6
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LASER2_WAVEFRONT_8

Instance id: | HED_IA2_LHEAT/SWITCH/LASER2_WAVEFRONT_8
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PILOT_LASER1_ENABLE

Instance id: | HED_IA2_LHEAT/SWITCH/PILOT_LASER1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | LaserControl, LASER_CONTROL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PILOT_LASER2_ENABLE

Instance id: | HED_IA2_LHEAT/SWITCH/PILOT_LASER2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-9
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### VAREX

##### 1

###### TRIG

Instance id: | HED_IA2_VAREX_1_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### 2

###### TRIG

Instance id: | HED_IA2_VAREX_2_TRIG
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### DETB

[add component documentation]

##### ADC

[add component documentation]

###### 1

Instance id: | HED_IA2_DETB_ADC_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_IA2_DETB_ADC_1|overview, IBS_DIODES, COMP_HED_EXP_IBS/ADC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### IC2

[add component documentation]

##### PMC

[add component documentation]

###### MCS2-1

##### MOTOR

[add component documentation]

###### AXIS0

###### AXIS1

###### AXIS2

###### AXIS3

###### AXIS4

###### AXIS5

###### AXIS6

###### AXIS10

###### AXIS11

###### AXIS12

###### AXIS7

###### AXIS8

###### AXIS9

###### AXIS13

###### AXIS15

###### AXIS16

#### LT

[add component documentation]

##### CAM

[add component documentation]

###### FSI

Instance id: | HED_IA2_LT/CAM/FSI
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | hed-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, 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.

### OGT

#### ALAS

##### DCTRL

###### SHUT_COIL

Instance id: | HED_OGT_ALAS/DCTRL/SHUT_COIL
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MIRR1_H

###### MIRR1_V

###### MIRR2_H

###### MIRR2_V

###### POP_IN_MIRR

##### SWITCH

###### SHUT_LO

Instance id: | HED_OGT_ALAS/SWITCH/SHUT_LO
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### CSLIT-1

##### MDL

###### CLEAN_SLIT-1

Instance id: | HED_OGT_CSLIT-1/MDL/CLEAN_SLIT-1
Class id: | SlitSystem
Host: | hed-rr-sys-con-2
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-rr-sys-con-2
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: | HED_EXP_MAIN, HED_EXP_CSLIT_1-Control_noTB, HED_EXP_CSLIT_1-Control, HED_OGT_CSLIT-1-SimpleControl, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT-1-SimpleControl, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT-1-SimpleControl
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

##### MOTOR

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

###### BLADE_BOTTOM

Instance id: | HED_OGT_CSLIT-1/TSENS/BLADE_BOTTOM
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_1-Control_noTB, HED_EXP_CSLIT_1-Control, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT_1-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_LEFT

Instance id: | HED_OGT_CSLIT-1/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_1-Control_noTB, HED_EXP_CSLIT_1-Control, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT_1-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_RIGHT

Instance id: | HED_OGT_CSLIT-1/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_1-Control_noTB, HED_EXP_CSLIT_1-Control, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT_1-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_TOP

Instance id: | HED_OGT_CSLIT-1/TSENS/BLADE_TOP
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_1-Control_noTB, HED_EXP_CSLIT_1-Control, HED_OGT_CSLIT_1-Control, HED_OGT_CSLIT_1-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE1

Instance id: | HED_OGT_CSLIT-1/TSENS/SPARE1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE2

Instance id: | HED_OGT_CSLIT-1/TSENS/SPARE2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE4

Instance id: | HED_OGT_CSLIT-1/TSENS/SPARE4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### CSLIT-2

##### MDL

###### CLEAN_SLIT-2

Instance id: | HED_OGT_CSLIT-2/MDL/CLEAN_SLIT-2
Class id: | SlitSystem
Host: | hed-rr-sys-con-2
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-rr-sys-con-2
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: | HED_EXP_MAIN, HED_OGT_CSLIT-2-SimpleControl, HED_OGT_CSLIT-2-SimpleControl, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT-2-SimpleControl
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

##### MOTOR

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

###### BLADE_BOTTOM

Instance id: | HED_OGT_CSLIT-2/TSENS/BLADE_BOTTOM
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_2-Control, HED_EXP_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_LEFT

Instance id: | HED_OGT_CSLIT-2/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_2-Control, HED_EXP_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_RIGHT

Instance id: | HED_OGT_CSLIT-2/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_2-Control, HED_EXP_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_TOP

Instance id: | HED_OGT_CSLIT-2/TSENS/BLADE_TOP
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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
Scenes: | HED_EXP_CSLIT_2-Control, HED_EXP_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control, HED_OGT_CSLIT_2-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### DPS

##### GAUGE

###### DPS_PG01

Instance id: | HED_OGT_DPS/GAUGE/DPS_PG01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_PG02

Instance id: | HED_OGT_DPS/GAUGE/DPS_PG02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_PG03

Instance id: | HED_OGT_DPS/GAUGE/DPS_PG03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_PG04

Instance id: | HED_OGT_DPS/GAUGE/DPS_PG04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PUMP

###### DPS_SP

##### TPUMP

###### DPS_TP01

Instance id: | HED_OGT_DPS/TPUMP/DPS_TP01
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_TP02

Instance id: | HED_OGT_DPS/TPUMP/DPS_TP02
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_TP03

Instance id: | HED_OGT_DPS/TPUMP/DPS_TP03
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_TP04

Instance id: | HED_OGT_DPS/TPUMP/DPS_TP04
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_T01

Instance id: | HED_OGT_DPS/TSENS/DPS_T01
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_T02

Instance id: | HED_OGT_DPS/TSENS/DPS_T02
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_T03

Instance id: | HED_OGT_DPS/TSENS/DPS_T03
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_T04

Instance id: | HED_OGT_DPS/TSENS/DPS_T04
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV01

Instance id: | HED_OGT_DPS/VALVE/DPS_AV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV02

Instance id: | HED_OGT_DPS/VALVE/DPS_AV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV03

Instance id: | HED_OGT_DPS/VALVE/DPS_AV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV04

Instance id: | HED_OGT_DPS/VALVE/DPS_AV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV05

Instance id: | HED_OGT_DPS/VALVE/DPS_AV05
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_AV06

Instance id: | HED_OGT_DPS/VALVE/DPS_AV06
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_GV01

Instance id: | HED_OGT_DPS/VALVE/DPS_GV01
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_GV02

Instance id: | HED_OGT_DPS/VALVE/DPS_GV02
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_GV03

Instance id: | HED_OGT_DPS/VALVE/DPS_GV03
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DPS_GV04

Instance id: | HED_OGT_DPS/VALVE/DPS_GV04
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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
Scenes: | exp_hutch_vac_old, HED_IA1_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### IPM

##### DCTRL

###### SCREEN_CAM

Instance id: | HED_OGT_IPM/DCTRL/SCREEN_CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-23 , hed-rr-sys-con-22 , hed-rr-sys-con-20 , hed-rr-sys-con-21 , hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DIODES_X

###### DIODES_Y

###### SCREENS_X

###### SCREENS_Y

##### ADC

[add component documentation]

###### 1

Instance id: | HED_OGT_IPM/ADC/1
Class id: | FastAdc
Host: | hed-rr-sys-utc-1
Class documentation:
| FastAdc
Alias: | exflqr33162-mch , exflutc221-mch
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/fastAdc
Last modified: | 2021-06-04T22:25:24.000+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Hauf, Fernandes, Ehsan
Latest tag: | 2.7.6-2.10.0
Deployment tag: | 2.7.6-2.10.0
Installed tag: | 2.7.5-2.10.0
Scenes: | IPM_Diodes, IPM_Diodes, IPM_PDs, IPM_APDs
Accessible by: | CONTROLS, CTRL, DET, babies, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.7.5-2.10.0) does not match tags mentioned in the deployment ([‘2.7.6-2.10.0’])!

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
- 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
- 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.
- 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”).
- 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
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- 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.7.6-2.10.0

Created: | 2021-06-02T07:25:59.000Z
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T13:52:10.000Z
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-26T11:52:36.000Z
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T13:31:13.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T15:43:01.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T14:25:10.000Z
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T08:12:17.000Z
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T17:36:37.000Z
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T12:38:00.000Z
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T12:27:17.000Z
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T07:56:32.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2.6.1-2.4.0

Created: | 2019-06-20T11:01:02.000Z
Author: | Steffen Hauf
Notes: |

2.6.0-2.4.0

Created: | 2019-06-03T10:58:20.000Z
Author: | Steffen Hauf
Notes: | Add the fasterADC device, which only outputs raw data

2.5.0-2.4.0

Created: | 2019-05-02T15:15:13.000Z
Author: | Alessandro Silenzi
Notes: | FIX: avoid sending old data if RAW not ready Documentation

2.4.2-2.2.6

Created: | 2018-12-10T09:34:19.000Z
Author: | Riccardo Fabbri
Notes: |

2.4.0-2.2.4-hotfix

Created: | 2018-11-09T17:19:27.000Z
Author: | utcaadm
Notes: |

2.4.1-2.2.6

Created: | 2018-11-09T12:57:53.000Z
Author: | Riccardo Fabbri
Notes: | individual trigger per channel added

2.4.0-2.2.4

Created: | 2018-11-06T13:12:24.000Z
Author: | Wajid Ehsan
Notes: |

2.3.3-2.2.3

Created: | 2018-06-04T07:39:55.000Z
Author: | Gabriele Giovanetti
Notes: | parameter dacNode.dacDataMode added to toggle WORD_DAC_MODE

2.3.2-2.2.0-hotfix

Created: | 2018-05-20T10:00:29.000Z
Author: | Sergey Esenov
Notes: | Update maxSize attribute of raw arrays in output to DAQ

##### CAM

[add component documentation]

###### SCREEN

Instance id: | HED_OGT_IPM/CAM/SCREEN
Class id: | LimaBaslerCamera
Host: | exflcon164
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-17
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-06-28T09:38:49.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.6.10-2.11.1
Deployment tag: | 5.6.10-2.11.1
Scenes: | ipm
Accessible by: | CONTROLS, CTRL, DA, danilevc, 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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.10-2.11.1

Created: | 2021-06-11T10:14:55.000Z
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-09T09:54:35.000Z
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

#### MOV

##### ASENS

###### Y

Instance id: | HED_OGT_MOV/ASENS/Y
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### Y

### OPR

#### PAM

##### CAM

###### SAMPLE

CAM
2

Instance id: | HED_OPR_PAM_CAM_SAMPLE_CAM_2
Host: | exflcon159
Alias: | hed-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2019-11-01T09:58:34.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Parenti, Fabbri, Mamchyk
Latest tag: | 1.2.1-2.6.1
Deployment tag: | 1.2.0-2.4.0
Installed tag: | 1.2.0-2.4.0
Accessible by: | CONTROLS, DA

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.

### OPT

#### ATT

##### MDL

###### ATT

Instance id: | HED_OPT_ATT/MDL/ATT
Class id: | JJAttenuator
Host: | hed-rr-sys-con-1
Class documentation:
| JJAttenuator
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_ATT/MDL/ATT_main, HED_OPT_MAIN, HED_OPT_ATT/MDL/ATT_main_alt, HED_STATUS_OVERVIEW, Check_list, HED_STATUS_OVERVIEW, HED_HPLAS_HIL/Shot_scene_old, Masterview, APP_EXP_2738_SPECTATOR, APP_2738_SPECTATOR_MAIN, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

###### ARM1

###### ARM2

###### ARM3

###### ARM4

###### CHAM_X

###### CHAM_Y

##### TSENS

###### ARM1_T1

Instance id: | HED_OPT_ATT/TSENS/ARM1_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM1_T2

Instance id: | HED_OPT_ATT/TSENS/ARM1_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM2_T1

Instance id: | HED_OPT_ATT/TSENS/ARM2_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM2_T2

Instance id: | HED_OPT_ATT/TSENS/ARM2_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM3_T1

Instance id: | HED_OPT_ATT/TSENS/ARM3_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM3_T2

Instance id: | HED_OPT_ATT/TSENS/ARM3_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM4_T1

Instance id: | HED_OPT_ATT/TSENS/ARM4_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM4_T2

Instance id: | HED_OPT_ATT/TSENS/ARM4_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### B4C_T1

Instance id: | HED_OPT_ATT/TSENS/B4C_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### B4C_T2

Instance id: | HED_OPT_ATT/TSENS/B4C_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### BIAS

##### DCTRL

###### HV_ILOCK_01

Instance id: | HED_OPT_BIAS/DCTRL/HV_ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HV_ILOCK_02

Instance id: | HED_OPT_BIAS/DCTRL/HV_ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_01

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_01
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_02

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_02
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_03

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_03
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_04

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_04
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_05

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_05
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_06

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_06
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_07

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_07
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV_ILOCK_08

Instance id: | HED_OPT_BIAS/DCTRL/LV_ILOCK_08
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_ENABLE

Instance id: | HED_OPT_BIAS/DCTRL/MPOD_BIAS_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### MPOD

Instance id: | HED_OPT_BIAS/MCPS/MPOD
Class id: | Mpod
Host: | hed-rr-sys-con-5
Class documentation:
| Mpod
Alias: | hed-rr-sys-con-5
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: | Diodes, HED_OPT_IPM/Diode_parameter, HED_OPT_PAM-Diodes, Diodes, HED_OPT_IPM-Diode_parameter, Masterview, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### BIU

##### ASENS

###### CHAMBER_Y

Instance id: | HED_OPT_BIU/ASENS/CHAMBER_Y
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_HOLDER_X

Instance id: | HED_OPT_BIU/ASENS/SCREEN_HOLDER_X
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### AVG

###### SCREEN

Instance id: | HED_OPT_BIU/AVG/SCREEN
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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’, ‘hedonc’]!

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

###### SCREEN

Instance id: | HED_OPT_BIU/CAM/SCREEN
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | HED_BIU, HED_OPT_BIU/CAM/SCREEN|scene
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

##### DCTRL

###### GRATING

Instance id: | HED_OPT_BIU/DCTRL/GRATING
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GRATING_LED

###### SCREEN

Instance id: | HED_OPT_BIU/DCTRL/SCREEN
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_BIU
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_LED

##### MOTOR

###### CHAMBER_Y

###### GRATING_AX

###### GRATING_X

###### SCREEN_CAM_AX

###### SCREEN_CAM_AZ

###### SCREEN_CAM_FOCUS

###### SCREEN_CAM_X

###### SCREEN_CAM_Y

###### SCREEN_CAM_Z

###### SCREEN_CAM_ZOOM

###### SCREEN_HOLDER_X

##### PROC

###### SCREEN

Instance id: | HED_OPT_BIU/PROC/SCREEN
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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: | HED_BIU
Accessible by: |

Warning

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

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.

##### TSENS

###### GRATING_TA

Instance id: | HED_OPT_BIU/TSENS/GRATING_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GRATING_TB

Instance id: | HED_OPT_BIU/TSENS/GRATING_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_TA

Instance id: | HED_OPT_BIU/TSENS/SCREEN_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_TB

Instance id: | HED_OPT_BIU/TSENS/SCREEN_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GRATING_TRIGGER

Instance id: | HED_OPT_BIU/TSYS/GRATING_TRIGGER
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### SCREEN_CAM_TRIGGER

Instance id: | HED_OPT_BIU/TSYS/SCREEN_CAM_TRIGGER
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

###### SCREEN_TRIGGER

Instance id: | HED_OPT_BIU/TSYS/SCREEN_TRIGGER
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

#### CRL

##### MDL

###### MAIN

Instance id: | HED_OPT_CRL/MDL/MAIN
Class id: | CompoundRefractiveLens
Host: | hed-rr-sys-con-1
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Scenes: | HED_OPT_CRL_MAIN, HED_OPT_CRL_MAIN_simple, HED_OPT_CRL_AlignLens1, HED_OPT_CRL_AlignLens2, HED_OPT_CRL_AlignLens3, HED_OPT_CRL_AlignLens4, HED_OPT_CRL_AlignLens5, HED_OPT_CRL_AlignLens6, HED_OPT_CRL_AlignLens7, HED_OPT_CRL_AlignLens8, HED_OPT_CRL_AlignLens9, HED_OPT_CRL_AlignLens10, HED_OPT_CRL/OverviewLensPositions, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/Shutdown, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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
- 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
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- 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: |

###### INTERLOCK_WATCHDOG

Instance id: | HED_OPT_CRL/MDL/INTERLOCK_WATCHDOG
Class id: | GenericActuator
Host: | exflcon180
Alias: | hed-rr-sys-con-7 , hed-rr-sys-con-stage
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
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

##### MOTOR

###### CHAM_AX

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

###### CHAM_Z

###### LENS10_X

###### LENS10_Y

###### LENS1_X

###### LENS1_Y

###### LENS2_X

###### LENS2_Y

###### LENS3_X

###### LENS3_Y

###### LENS4_X

###### LENS4_Y

###### LENS5_X

###### LENS5_Y

###### LENS6_X

###### LENS6_Y

###### LENS7_X

###### LENS7_Y

###### LENS8_X

###### LENS8_Y

###### LENS9_X

###### LENS9_Y

##### TSENS

###### LENS10_T1

Instance id: | HED_OPT_CRL/TSENS/LENS10_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS10_T2

Instance id: | HED_OPT_CRL/TSENS/LENS10_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS1_T1

Instance id: | HED_OPT_CRL/TSENS/LENS1_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS1_T2

Instance id: | HED_OPT_CRL/TSENS/LENS1_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS2_T1

Instance id: | HED_OPT_CRL/TSENS/LENS2_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS2_T2

Instance id: | HED_OPT_CRL/TSENS/LENS2_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS3_T1

Instance id: | HED_OPT_CRL/TSENS/LENS3_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS3_T2

Instance id: | HED_OPT_CRL/TSENS/LENS3_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS4_T1

Instance id: | HED_OPT_CRL/TSENS/LENS4_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS4_T2

Instance id: | HED_OPT_CRL/TSENS/LENS4_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS5_T1

Instance id: | HED_OPT_CRL/TSENS/LENS5_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS5_T2

Instance id: | HED_OPT_CRL/TSENS/LENS5_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS6_T1

Instance id: | HED_OPT_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS6_T2

Instance id: | HED_OPT_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS7_T1

Instance id: | HED_OPT_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS7_T2

Instance id: | HED_OPT_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS8_T1

Instance id: | HED_OPT_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS8_T2

Instance id: | HED_OPT_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS9_T1

Instance id: | HED_OPT_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS9_T2

Instance id: | HED_OPT_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### HED_CRL3_OK

Instance id: | HED_OPT_CRL/DCTRL/HED_CRL3_OK
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MPS_OUT

Instance id: | HED_OPT_CRL/DCTRL/MPS_OUT
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### LENS10_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS10_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS10_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS10_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS1_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS1_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS1_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS1_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS2_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS2_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS2_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS2_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS3_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS3_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS3_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS3_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS4_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS4_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS4_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS4_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS5_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS5_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS5_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS5_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS6_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS6_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS6_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS6_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS7_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS7_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS7_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS7_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS8_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS8_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS8_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS8_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS9_OUT1

Instance id: | HED_OPT_CRL/SWITCH/LENS9_OUT1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_MAIN, HED_OPT_CRL/OverviewLensPositions, HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LENS9_OUT2

Instance id: | HED_OPT_CRL/SWITCH/LENS9_OUT2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_CRL-SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### VDCTRL

[add component documentation]

###### HED_CRL3_OK

Instance id: | HED_OPT_CRL/VDCTRL/HED_CRL3_OK
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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]

###### CRL3_OK_FROMLOOP1

Instance id: | HED_OPT_CRL/VSWITCH/CRL3_OK_FROMLOOP1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### IPM

##### ADC

###### 1

Instance id: | HED_OPT_IPM_ADC_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | HED_OPT_IPM/Diode_parameter, Diodes, HED_OPT_IPM-Diode_parameter
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### ASENS

###### CHAMBER_X

Instance id: | HED_OPT_IPM/ASENS/CHAMBER_X
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CHAMBER_Y

Instance id: | HED_OPT_IPM/ASENS/CHAMBER_Y
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_HOLDER_X

Instance id: | HED_OPT_IPM/ASENS/SCREEN_HOLDER_X
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### CAM

###### SCREEN

Instance id: | HED_OPT_IPM/CAM/SCREEN
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-5
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_OPT_IPM/CAM/SCREEN|scene, HED_OPT_IPM, HED_OPT_IPM_TEST, HED_OPT_IPM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### DCTRL

###### SCREEN_CAM

Instance id: | HED_OPT_IPM/DCTRL/SCREEN_CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_IPM/CAM/SCREEN|scene, HED_OPT_IPM, HED_OPT_IPM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_LED

##### MCPS

###### BIAS

MPOD Documentation

- Troubleshooting
- General mpod package documentation

##### MOTOR

###### CHAMBER_X

###### CHAMBER_Y

###### SCREEN_HOLDER_X

###### DIODE_HOLDER_Z

Instance id: | HED_OPT_IPM/MOTOR/DIODE_HOLDER_Z
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-19T15:52:08.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Bondar
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

[add instance documentation]

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.

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

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### NORMALIZER

###### NORMALIZE

##### NORMALIZERML

###### TEST

##### PMOTOR

###### DIODE_HOLDER_Z

Instance id: | HED_OPT_IPM/PMOTOR/DIODE_HOLDER_Z
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PROC

###### ADC_OUTPUT

Instance id: | HED_OPT_IPM/PROC/ADC_OUTPUT
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

###### SCREEN

Instance id: | HED_OPT_IPM/PROC/SCREEN
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

##### TSENS

###### DIODES_TA

Instance id: | HED_OPT_IPM/TSENS/DIODES_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DIODES_TB

Instance id: | HED_OPT_IPM/TSENS/DIODES_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_TA

Instance id: | HED_OPT_IPM/TSENS/SCREEN_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN_TB

Instance id: | HED_OPT_IPM/TSENS/SCREEN_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SCREEN

Instance id: | HED_OPT_IPM/TSYS/SCREEN
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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, 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: |

##### MATCHER

[add component documentation]

###### NORMALIZE

Instance id: | HED_OPT_IPM/MATCHER/NORMALIZE
Class id: | TrainMatcher
Host: | exflcon134
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2020-07-30T14:47:26.000+02: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’, ‘hedonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

#### PAM

##### AVE

###### HDR_CAM_1

Instance id: | HED_OPT_PAM/AVE/HDR_CAM_1
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Scenes: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0, HDR_1_average_background
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

###### SAMPLE_CAM_3

Instance id: | HED_OPT_PAM/AVE/SAMPLE_CAM_3
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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: | SAMPLE_CAM_3_average_background
Accessible by: |

Warning

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

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.

###### SPATIAL_CAM

Instance id: | HED_OPT_PAM/AVE/SPATIAL_CAM
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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: | PAM-Spatial_simplified, PAM-Spatial-NEW, PAM_Spatial_BGsubtraction_July2020, PAM-Spatial-NEW_3
Accessible by: |

Warning

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

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.

###### SPECTRAL_CAM

Instance id: | HED_OPT_PAM/AVE/SPECTRAL_CAM
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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: | PAM-Spectral_MAIN, PAM-Spatial_simplified, Spectral_cam_average_background, Spectral_cam_July2020, PAM-Spectral_MAIN, PAM-Spectral_MAIN
Accessible by: |

Warning

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

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.

###### HDR_CAM_1_TEST

Instance id: | HED_OPT_PAM/AVE/HDR_CAM_1_TEST
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0
Accessible by: |

Warning

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

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.

###### SPATIAL_SPECTRAL

Instance id: | HED_OPT_PAM/AVE/SPATIAL_SPECTRAL
Class id: | ImageAverager
Host: | exflcon134
Alias: | hed-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: | PAM_Substracted_average
Accessible by: |

Warning

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

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.

##### BGC

###### HDR_CAM_1

Instance id: | HED_OPT_PAM/BGC/HDR_CAM_1
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Scenes: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0, HDR_1_average_background
Accessible by: |

Warning

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

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

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

###### SAMPLE_CAM_3

Instance id: | HED_OPT_PAM/BGC/SAMPLE_CAM_3
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-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: | SAMPLE_CAM_3_average_background
Accessible by: |

Warning

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

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.

###### SPECTRAL_CAM

Instance id: | HED_OPT_PAM/BGC/SPECTRAL_CAM
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-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: | Image_subtraction_Spatial, PAM-Spectral_MAIN, PAM-Spatial_simplified, Spectral_cam_average_background, Spectral_cam_July2020, HED_OPT_PAM/MAIN, HED_OPT_PAM/MAIN, PAM-Spectral_MAIN, PAM-Spectral_MAIN
Accessible by: |

Warning

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

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.

###### SPATIAL_CAM

Instance id: | HED_OPT_PAM/BGC/SPATIAL_CAM
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-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: | Image_subtraction_Spatial, PAM-Spatial_simplified, PAM-Spatial-NEW, PAM_Spatial_BGsubtraction_July2020, PAM-Spatial-NEW_3
Accessible by: |

Warning

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

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.

###### HDR_CAM_1_TEST

Instance id: | HED_OPT_PAM/BGC/HDR_CAM_1_TEST
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-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: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0
Accessible by: |

Warning

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

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.

###### SPATIAL_SPECTRL

Instance id: | HED_OPT_PAM/BGC/SPATIAL_SPECTRL
Class id: | ImageBackgroundSubtraction
Host: | exflcon134
Alias: | hed-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: | PAM_Substracted_average
Accessible by: |

Warning

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

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.

##### CAM

###### HDR_CAM_1

Instance id: | HED_OPT_PAM/CAM/HDR_CAM_1
Class id: | PhotonicScience2kx2k
Host: | exflcon134
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/photonicScienceDualCamera
Last modified: | 2020-11-25T10:17:16.000+01:00
Created at: | 2017-02-13T13:17:16.000+01:00
Main authors: | Parenti, Hauf, Kirienko
Latest tag: | 1.2.2-2.10.0
Deployment tag: | 1.2.2-2.10.0
Scenes: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST|scene, HED_OPT_PAM/CAM/HDR_CAM_1, HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0, HED_OPT_PAM/CAM/HDR_CAM_1|scene, all_camera_temp, HDR_1_average_background, HED_2kx2k_TEST, HED_OPT_PAM/CAM/HDR_CAM_1_TEST
Accessible by: |

Warning

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- frameRateIn:
    The incoming frame rate.
- frameRateOut:
    The outgoing frame rate.

Release History
1.2.2-2.10.0

Created: | 2020-11-25T10:03:30.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.1-2.8.3

Created: | 2020-06-03T10:20:05.000Z
Author: | Andrea Parenti
Notes: | Update imageProcessor to latest tag

1.2.0-2.6.4

Created: | 2019-12-06T16:01:10.000Z
Author: | Yury Kirienko
Notes: | PhotonicScienceCalibrator was rewritten from scratch.

1.1.0-2.6.2

Created: | 2019-10-18T15:12:22.000Z
Author: | Andrea Parenti
Notes: | Add descrambling device for 2k x 2k single GigE camera

1.0.0-2.4

Created: | 2019-05-20T10:46:32.000Z
Author: | Andrea Parenti
Notes: | ADD PhotonicScienceCalibrator for reference subtraction ADD tests and CI configuration

0.3.0-2.2.6

Created: | 2018-10-24T13:28:02.000Z
Author: | Andrea Parenti
Notes: | Finish update for 2.2.x Remove file saving feature

0.2.0-2.2.4

Created: | 2018-09-21T09:49:36.000Z
Author: | Yury Kirienko
Notes: |

0.1.0-1.4

Created: | 2016-07-25T10:20:54.000Z
Author: | Andrea Parenti
Notes: | Package photonicScienceDualCamera got tagged from “branches/0.1-1.4” to “tags/0.1.0-1.4” via karabo script

###### HDR_CAM_1_TEST

Instance id: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST
Class id: | PhotonicScienceCamera
Host: | exflcon134
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2020-11-24T11:28:59.000+01:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Scenes: | HED_OPT_PAM/CAM/HDR_CAM_1_TEST|scene, HED_OPT_PAM/CAM/HDR_CAM_1, HED_OPT_PAM/CAM/HDR_CAM_1_TEST_0, HED_2kx2k_TEST, HED_OPT_PAM/CAM/HDR_CAM_1_TEST
Accessible by: |

Warning

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

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T10:38:08.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T09:47:57.000Z
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### SAMPLE_CAM_1

Instance id: | HED_OPT_PAM/CAM/SAMPLE_CAM_1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-5
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: | Beam_alignment, PAM-Spatial-NEW, HED_OPT_PAM/CAM/SAMPLE_CAM_1|scene, Iris_A10_PAM, PAM-Spatial-MAIN, PAM-Spatial-NEW_3, PAM-Spatial-MAIN, PAM-Spatial-MAIN, Iris_PAM, Iris_A10_PAM, Iris_PAM, Iris_on_Spectral_arm, PAM_Spatial_Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

###### SAMPLE_CAM_2

Instance id: | HED_OPT_PAM/CAM/SAMPLE_CAM_2
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Scenes: | HED_OPT_PAM/CAM/SAMPLE_CAM_2|scene
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

###### SAMPLE_CAM_3

Instance id: | HED_OPT_PAM/CAM/SAMPLE_CAM_3
Class id: | LimaBaslerCamera
Host: | exflcon134
Class documentation:
| LimaBaslerCamera
Alias: | hed-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: | PAM-Spatial-NEW, SAMPLE_CAM_3_average_background, HED_OPT_PAM/CAM/SAMPLE_CAM_3|scene, HED_EXP_PSC/PROC_AVG_BKS
Accessible by: |

Warning

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

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

###### SAMPLE_CAM_4

GENICAM CAMERAS

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

###### SPATIAL_CAM

Instance id: | HED_OPT_PAM/CAM/SPATIAL_CAM
Class id: | PhotonicScienceCamera
Host: | hed-rr-sys-con-5
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Installed tag: | 3.11.7-2.10.0
Scenes: | Image_subtraction_Spatial, PAM-Spatial_simplified, HED_OPT_PAM/CAM/SPATIAL_CAM|scene, PAM-Spatial-NEW, PAM_Spatial_BGsubtraction_July2020, PAM-Spatial-NEW_3, PAM_Spatial_Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

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

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### SPECTRAL_CAM

Instance id: | HED_OPT_PAM/CAM/SPECTRAL_CAM
Class id: | PhotonicScienceCamera
Host: | hed-rr-sys-con-5
Class documentation:
| PhotonicScienceCamera
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Installed tag: | 3.11.7-2.10.0
Scenes: | Image_subtraction_Spatial, PAM-Spectral_MAIN, PAM-Spatial_simplified, HED_OPT_PAM/CAM/SPECTRAL_CAM|scene, Spectral_cam_average_background, Spectral_cam_July2020, PAM-Spectral_MAIN, PAM-Spectral_MAIN, Spectral_CAM_Alignment
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam 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 (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- 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
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

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

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### SAMPLE

CAM
1

Instance id: | HED_OPT_PAM_CAM_SAMPLE_CAM_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

2

Instance id: | HED_OPT_PAM_CAM_SAMPLE_CAM_2
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

3

Instance id: | HED_OPT_PAM_CAM_SAMPLE_CAM_3
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

###### ACA1920-1

Instance id: | HED_OPT_PAM/CAM/ACA1920-1
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-17
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-17
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: | aca_1920_incoupling_prism
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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.

##### DCTRL

###### SAMPLE_CAM_1

Instance id: | HED_OPT_PAM/DCTRL/SAMPLE_CAM_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/CAM/SAMPLE_CAM_1|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SAMPLE_CAM_2

Instance id: | HED_OPT_PAM/DCTRL/SAMPLE_CAM_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/CAM/SAMPLE_CAM_2|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SAMPLE_CAM_3

Instance id: | HED_OPT_PAM/DCTRL/SAMPLE_CAM_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | PAM-Spatial-NEW, HED_OPT_PAM/CAM/SAMPLE_CAM_3|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SAMPLE_CAM_4

Instance id: | HED_OPT_PAM/DCTRL/SAMPLE_CAM_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | PAM-Spectral_MAIN, HED_OPT_PAM/CAM/SAMPLE_CAM_4|scene, PAM-Spectral_MAIN, PAM-Spectral_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CH1_MIC_FOCUS

###### CH1_SAMPLE_ROT

###### CH1_SAMPLE_X

###### CH1_SAMPLE_Y

###### CH1_SAMPLE_Z

###### CH2_MIRR_IN_X

###### CH2_MIRR_IN_Y

###### CH2_MIRR_OUT_X

###### CH2_MIRR_OUT_Y

###### CH2_SAMPLE_ROT

###### CH2_SAMPLE_X

###### CH2_SAMPLE_Y

###### CH2_SAMPLE_Z

###### DELAY

###### MIRR_1E_H

###### MIRR_1E_V

###### MIRR_2_H

###### MIRR_2_V

###### MIRR_3_H

###### MIRR_3_V

###### MIRR_4_H

###### MIRR_4_V

###### SPARE_1

###### SPARE_2

###### SPARE_3

###### SPARE_4

###### SPARE_5

###### SPARE_6

##### PMOTOR

###### CH2_MIRR_IN_H

Instance id: | HED_OPT_PAM/PMOTOR/CH2_MIRR_IN_H
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/PMOTOR/CH2_MIRR_IN_H|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CH2_MIRR_IN_V

Instance id: | HED_OPT_PAM/PMOTOR/CH2_MIRR_IN_V
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/PMOTOR/CH2_MIRR_IN_V|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CH2_MIRR_OUT_H

Instance id: | HED_OPT_PAM/PMOTOR/CH2_MIRR_OUT_H
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/PMOTOR/CH2_MIRR_OUT_H|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CH2_MIRR_OUT_V

Instance id: | HED_OPT_PAM/PMOTOR/CH2_MIRR_OUT_V
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_OPT_PAM/PMOTOR/CH2_MIRR_OUT_V|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIEZO_1

Instance id: | HED_OPT_PAM/PMOTOR/PIEZO_1
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIEZO_2

Instance id: | HED_OPT_PAM/PMOTOR/PIEZO_2
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIEZO_3

Instance id: | HED_OPT_PAM/PMOTOR/PIEZO_3
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PIEZO_4

Instance id: | HED_OPT_PAM/PMOTOR/PIEZO_4
Class id: | BeckhoffMC2Base
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### PROC

###### HDR_CAM_1

Instance id: | HED_OPT_PAM/PROC/HDR_CAM_1
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Scenes: | HDR_1_average_background
Accessible by: |

Warning

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

Image Processor

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

###### SAMPLE_CAM_3

Instance id: | HED_OPT_PAM/PROC/SAMPLE_CAM_3
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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: | SAMPLE_CAM_3_average_background
Accessible by: |

Warning

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

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.

###### SPATIAL_CAM

Instance id: | HED_OPT_PAM/PROC/SPATIAL_CAM
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

###### SPECTRAL_CAM

Instance id: | HED_OPT_PAM/PROC/SPECTRAL_CAM
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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: | Spectral_cam_average_background
Accessible by: |

Warning

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

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.

###### HDR_CAM_1_TEST

Instance id: | HED_OPT_PAM/PROC/HDR_CAM_1_TEST
Class id: | ImageProcessor
Host: | exflcon134
Class documentation:
| ImageProcessor
Alias: | hed-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’, ‘hedonc’]!

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.

###### ACA1920-1

Instance id: | HED_OPT_PAM/PROC/ACA1920-1
Class id: | ImageProcessor
Host: | exflcon164
Class documentation:
| ImageProcessor
Alias: | hed-rr-sys-con-17
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’, ‘hedonc’]!

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.

##### HDR

###### CAM

1

Instance id: | HED_OPT_PAM_HDR_CAM_1
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers, PAM-Spatial-MAIN, PAM-Spatial-NEW_3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### SAMPLE

###### CAM

1

Instance id: | HED_OPT_PAM_SAMPLE_CAM_1
Host: | exflcon159
Alias: | hed-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2019-11-01T09:58:34.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Parenti, Fabbri, Mamchyk
Latest tag: | 1.2.1-2.6.1
Deployment tag: | 1.2.0-2.4.0
Installed tag: | 1.2.0-2.4.0
Accessible by: | CONTROLS, DA

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.

##### SPATIAL

###### CAM

Instance id: | HED_OPT_PAM_SPATIAL_CAM
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers, PAM-Spatial-MAIN, PAM-Spectral_MAIN, PAM-Spatial-MAIN, PAM_Spatial_Main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

##### SPECTRAL

###### CAM

Instance id: | HED_OPT_PAM_SPECTRAL_CAM
Class id: | X2TimerML
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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
Scenes: | Timers, Timers, PAM-Spectral_MAIN, PAM-Spectral_MAIN
Accessible by: | CONTROLS, CTRL, DA, danilevc, 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: |

##### CAMDIFF

###### SPATIAL_SPECTRAL

##### AVG

[add component documentation]

###### ACA1920-1

Instance id: | HED_OPT_PAM/AVG/ACA1920-1
Class id: | ImageAverager
Host: | exflcon164
Alias: | hed-rr-sys-con-17
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’, ‘hedonc’]!

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.

#### PSLIT

##### MDL

###### POWER_SLIT

Instance id: | HED_OPT_PSLIT/MDL/POWER_SLIT
Class id: | SlitSystem
Host: | hed-rr-sys-con-1
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_PSLIT-SimpleControl, HED_OPT_MAIN, HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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

##### MOTOR

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

###### APERTURE_TA

Instance id: | HED_OPT_PSLIT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### APERTURE_TB

Instance id: | HED_OPT_PSLIT/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_BOTTOM_TA

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_BOTTOM_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_BOTTOM_TB

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_BOTTOM_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_LEFT_TA

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_LEFT_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_LEFT_TB

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_LEFT_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_RIGHT_TA

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_RIGHT_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_RIGHT_TB

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_RIGHT_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_TOP_TA

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_TOP_TA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE_TOP_TB

Instance id: | HED_OPT_PSLIT/TSENS/BLADE_TOP_TB
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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
Projects: | HED_OPT_PSLIT
Scenes: | HED_OPT_PSLIT-Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### SBM

##### ASENS

###### CHAMBER_Y

Instance id: | HED_OPT_SBM/ASENS/CHAMBER_Y
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CAM

Instance id: | HED_OPT_SBM/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### ARM_1

###### ARM_2

###### CHAMBER_Y

##### CAM

[add component documentation]

###### SCREEN

Instance id: | HED_OPT_SBM/CAM/SCREEN
Class id: | LimaBaslerCamera
Host: | hed-rr-sys-con-17
Class documentation:
| LimaBaslerCamera
Alias: | hed-rr-sys-con-17
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras
Last modified: | 2021-04-30T18:11:14.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 5.7.3-2.10.4
Deployment tag: | 5.7.3-2.10.4
Installed tag: | 5.6.9-2.10.0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.3-2.10.4’])!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.7.3-2.10.4

Created: | 2021-04-30T16:51:12.000Z
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T13:22:08.000Z
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-03T17:21:34.000Z
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

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

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

#### SPP

##### DCTRL

###### GDB

Instance id: | HED_OPT_SPP/DCTRL/GDB
Host: | exflcon151
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

###### DO_1

Instance id: | HED_OPT_SPP/DCTRL/DO_1
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_2

Instance id: | HED_OPT_SPP/DCTRL/DO_2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_3

Instance id: | HED_OPT_SPP/DCTRL/DO_3
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DO_4

Instance id: | HED_OPT_SPP/DCTRL/DO_4
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_IA1_IC/CAM/FISHEYE_VIEW|scene, HED_IA1_IC-CAM-FISHEYE_VIEW-scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CHAMBER_X

Instance id: | HED_OPT_SPP/MOTOR/CHAMBER_X
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### CHAMBER_Y

Instance id: | HED_OPT_SPP/MOTOR/CHAMBER_Y
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### CRYSTAL_AX

Instance id: | HED_OPT_SPP/MOTOR/CRYSTAL_AX
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### CRYSTAL_X

Instance id: | HED_OPT_SPP/MOTOR/CRYSTAL_X
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### DET_AX

Instance id: | HED_OPT_SPP/MOTOR/DET_AX
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### DET_AY

Instance id: | HED_OPT_SPP/MOTOR/DET_AY
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### DET_SWAP

Instance id: | HED_OPT_SPP/MOTOR/DET_SWAP
Host: | exflcon151
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

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.

###### INC_ENC_1

###### INC_ENC_2

###### SINCOS_ENC

###### SM_L_1

###### SM_L_2

###### SM_L_3

###### SM_L_4

###### SM_M_1

###### SM_M_2

###### SSI_ENC

Instance id: | HED_OPT_SPP/MOTOR/SSI_ENC
Class id: | BeckhoffEncoder
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### ACTRL

###### AO_1

Instance id: | HED_OPT_SPP/ACTRL/AO_1
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | HED_IA1_FSSS_MAIN_old, HED_EXP_IA1_VAC, Comissining_main_scenes, HED_EXP_MAIN, HED_IA1_IC/CAM/FISHEYE_VIEW|scene, HED_IA1_LASER_ALIGNMENT, HED_IA1_IC-CAM-FISHEYE_VIEW-scene, A12_alignment, APP_EXP_2716/AligmentScene, APP_EXP_2716/SampleAlignment, Sample_alignment, A12_alignment, APP_HED_EXP_MAIN/HED_ILLUMINATION, Masterview, MasterView_Old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AO_2

Instance id: | HED_OPT_SPP/ACTRL/AO_2
Class id: | BeckhoffAnalogOutput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_1

Instance id: | HED_OPT_SPP/ASENS/AI_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_2

Instance id: | HED_OPT_SPP/ASENS/AI_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_3

Instance id: | HED_OPT_SPP/ASENS/AI_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### AI_4

Instance id: | HED_OPT_SPP/ASENS/AI_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### SWITCH

###### DI_1

Instance id: | HED_OPT_SPP/SWITCH/DI_1
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_2

Instance id: | HED_OPT_SPP/SWITCH/DI_2
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_3

Instance id: | HED_OPT_SPP/SWITCH/DI_3
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### DI_4

Instance id: | HED_OPT_SPP/SWITCH/DI_4
Class id: | BeckhoffDigitalInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_1

Instance id: | HED_OPT_SPP/TSENS/T_1
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_2

Instance id: | HED_OPT_SPP/TSENS/T_2
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_3

Instance id: | HED_OPT_SPP/TSENS/T_3
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T_4

Instance id: | HED_OPT_SPP/TSENS/T_4
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### SSP

##### DCTRL

###### CAM2

Instance id: | HED_OPT_SSP/DCTRL/CAM2
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GDB

Instance id: | HED_OPT_SSP/DCTRL/GDB
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CHAMBER_X

###### CHAMBER_Y

###### CRYSTAL_AX

###### CRYSTAL_X

###### DET_AX

###### DET_AY

###### DET_SWAP

#### SYS

##### PLC

###### BECKHOFF_MON

Instance id: | HED_OPT_SYS/PLC/BECKHOFF_MON
Class id: | BeckhoffMonitor
Host: | hed-rr-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-2 , hed-rr-sys-con-22 , hed-rr-sys-con-21 , hed-rr-sys-con-20 , hed-rr-sys-con-23
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2021-06-02T11:48:16.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.6-2.10.0
Deployment tag: | 1.1.6-2.10.0
Installed tag: | 1.1.5-2.10.0
Scenes: | HED_OPT_SYS/PLC/BECKHOFF_MON|Overview, HED_OPT_SYS/PLC/BECKHOFF_MON|Export PLC params
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.1.5-2.10.0) does not match tags mentioned in the deployment ([‘1.1.6-2.10.0’])!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Provides scenes for monitor
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Instantiate all devices on selected PLC
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- reset:
    Resets this Monitor device

Release History
1.1.6-2.10.0

Created: | 2021-05-20T17:08:59.000Z
Author: | Sergey Esenov
Notes: | Adapted to Python 3.8.x. No new features.

1.1.5-2.9.1

Created: | 2020-11-16T09:27:47.000Z
Author: | Riccardo Fabbri
Notes: | Update version info according to documentation https://in.xfel.eu/readthedocs/docs/karabo/en/latest/library/device_version.html

1.1.5-2.10.0

Created: | 2020-11-16T09:27:47.000Z
Author: | Riccardo Fabbri
Notes: | Indicate 2.10 compatibility

1.1.4-2.4.2

Created: | 2019-05-28T09:54:20.000Z
Author: | Yury Kirienko
Notes: | State handling enhanced

1.1.3-2.4.0

Created: | 2019-05-21T11:20:15.000Z
Author: | Riccardo Fabbri
Notes: |

1.1.2-2.4.0

Created: | 2019-05-09T16:43:42.000Z
Author: | Riccardo Fabbri
Notes: | Bug-fix to slotInstanceGone slot: redmine #32843 Scene to select PLC added (Yury) Reset slot added

1.1.1-2.4.0

Created: | 2019-04-30T12:17:25.000Z
Author: | Riccardo Fabbri
Notes: | Added variables to SD_MC2BECKHOFF

1.1.0-2.4.0

Created: | 2019-04-30T08:50:21.000Z
Author: | Riccardo Fabbri
Notes: | Bug-fix: State error handled: redmine #32841

1.0.9-2.4.0

Created: | 2019-03-11T15:27:14.000Z
Author: | Alessandro Silenzi
Notes: | Compatibility with new beckhoff methods to retrieve schema

1.0.8-2.2.6

Created: | 2018-11-06T16:39:58.000Z
Author: | Riccardo Fabbri
Notes: | PLC config saved in git repo

1.0.7-2.2.4

Created: | 2018-09-05T10:40:28.000Z
Author: | Riccardo Fabbri
Notes: | Optimized Saving of PLC device config

2.0.0a0

Created: | 2018-06-15T15:56:09.000Z
Author: | rfabbri
Notes: | working xml download

1.0.6-2.2.0

Created: | 2018-02-05T10:06:05.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.2.0

Created: | 2018-02-05T10:06:05.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.2.0

Created: | 2018-01-17T13:05:28.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.0

Created: | 2018-01-16T15:01:25.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.0

Created: | 2018-01-16T13:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.2.0

Created: | 2018-01-15T17:00:15.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.0

Created: | 2018-01-15T16:46:45.000Z
Author: | Dennis Goeries
Notes: |

##### TSYS

###### UTC-1-S2

Instance id: | HED_OPT_SYS/TSYS/UTC-1-S2
Class id: | X2Timer
Host: | hed-rr-sys-con-gui2
Alias: | hed-rr-sys-con-gui2
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.13-2.11.1
Scenes: | ADC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

#### VAC

##### 2

Instance id: | HED_OPT_VAC/2
Host: | exflcon151
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-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

##### GAUGE

###### PG_ATT

Instance id: | HED_OPT_VAC/GAUGE/PG_ATT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_CRL

Instance id: | HED_OPT_VAC/GAUGE/PG_CRL
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_PAM

Instance id: | HED_OPT_VAC/GAUGE/PG_PAM
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_PPT_EXP

Instance id: | HED_OPT_VAC/GAUGE/PG_PPT_EXP
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_PPT_PAM

Instance id: | HED_OPT_VAC/GAUGE/PG_PPT_PAM
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_PSLIT

Instance id: | HED_OPT_VAC/GAUGE/PG_PSLIT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_SA

Instance id: | HED_OPT_VAC/GAUGE/PG_SA
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_SHUT

Instance id: | HED_OPT_VAC/GAUGE/PG_SHUT
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_EXP_IA1_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_SPARE

Instance id: | HED_OPT_VAC/GAUGE/PG_SPARE
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PG_TRPIPE

Instance id: | HED_OPT_VAC/GAUGE/PG_TRPIPE
Class id: | BeckhoffAnalogInput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CTRLIPCTRL_1

Instance id: | HED_OPT_VAC/ICTRL/CTRLIPCTRL_1
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CTRLIPCTRL_2

Instance id: | HED_OPT_VAC/ICTRL/CTRLIPCTRL_2
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CTRLIPCTRL_3

Instance id: | HED_OPT_VAC/ICTRL/CTRLIPCTRL_3
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### CTRLIPCTRL_4

Instance id: | HED_OPT_VAC/ICTRL/CTRLIPCTRL_4
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_ATT

Instance id: | HED_OPT_VAC/IPUMP/IP_ATT
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_CRL

Instance id: | HED_OPT_VAC/IPUMP/IP_CRL
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_PAM

Instance id: | HED_OPT_VAC/IPUMP/IP_PAM
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_PSLIT

Instance id: | HED_OPT_VAC/IPUMP/IP_PSLIT
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SA

Instance id: | HED_OPT_VAC/IPUMP/IP_SA
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SHUT

Instance id: | HED_OPT_VAC/IPUMP/IP_SHUT
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_TRPIPE_1

Instance id: | HED_OPT_VAC/IPUMP/IP_TRPIPE_1
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_TRPIPE_2

Instance id: | HED_OPT_VAC/IPUMP/IP_TRPIPE_2
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_1

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_1
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_2

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_2
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_3

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_3
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_4

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_4
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_5

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_5
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_7

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_7
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_6

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_6
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_SPARE_8

Instance id: | HED_OPT_VAC/IPUMP/IP_SPARE_8
Class id: | BeckhoffAgilentIonPump
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### TPUMP

###### TP_SPARE_1

Instance id: | HED_OPT_VAC/TPUMP/TP_SPARE_1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TP_SPARE_2

Instance id: | HED_OPT_VAC/TPUMP/TP_SPARE_2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_1

Instance id: | HED_OPT_VAC/VALVE/GV_1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | exp_hutch_vac_old, HED_OPT_VAC, HED_OPT_MAIN, HED_IA1_VAC, HED_EXP_IA1_VAC, HED_EXP_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_2

Instance id: | HED_OPT_VAC/VALVE/GV_2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_3

Instance id: | HED_OPT_VAC/VALVE/GV_3
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_4

Instance id: | HED_OPT_VAC/VALVE/GV_4
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_5

Instance id: | HED_OPT_VAC/VALVE/GV_5
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_6

Instance id: | HED_OPT_VAC/VALVE/GV_6
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_7

Instance id: | HED_OPT_VAC/VALVE/GV_7
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_STATUS_OVERVIEW, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_8

Instance id: | HED_OPT_VAC/VALVE/GV_8
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | HED_OPT_VAC, HED_OPT_MAIN, HED_EXP_IA1_VAC, HED_EXP_MAIN, HED_STATUS_OVERVIEW, APP_HED_EXP_MAIN/Shutdown, HED_STATUS_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_SPARE_1

Instance id: | HED_OPT_VAC/VALVE/GV_SPARE_1
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_SPARE_2

Instance id: | HED_OPT_VAC/VALVE/GV_SPARE_2
Class id: | BeckhoffValve
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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]

###### GV_1_OPEN

Instance id: | HED_OPT_VAC/VDCTRL/GV_1_OPEN
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_TRPIPE_1_ON_SP

Instance id: | HED_OPT_VAC/VDCTRL/IP_TRPIPE_1_ON_SP
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### IP_TRPIPE_2_ON_SP

Instance id: | HED_OPT_VAC/VDCTRL/IP_TRPIPE_2_ON_SP
Class id: | BeckhoffDigitalOutput
Host: | hed-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### RR

#### SYS

##### PROC

###### PROPAVG

###### PROPAVG0

###### PROPAVG1

###### PROPAVG2

###### CINEBACON

###### PAVG_IMG

##### MDL

###### BASEBACON

Instance id: | HED_RR_SYS/MDL/BASEBACON
Host: | exflcon168
Alias: | hed-rr-sys-con-9
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
Installed tag: | 1.5.0-2.6.0
Scenes: | HED_RR_SYS/MDL/BASEBACON_Old, HED_RR_SYS/MDL/BASEBACON|MainControl, HED_RR_SYS/PROC/CINEBACON|cockpit, HED_RR_SYS/PROC/CINEBACON|cockpit, HED_RR_SYS/PROC/CINEBACON|cockpit
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=1 day, 21:11:00!

Warning

The installed tag (1.5.0-2.6.0) does not match tags mentioned in the deployment ([‘1.6.1-2.6.0’])!

###### DAQ_CTRL

Instance id: | HED_RR_SYS/MDL/DAQ_CTRL
Class id: | DaqController
Host: | hed-rr-sys-con-4
Alias: | hed-rr-sys-con-4
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, 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.
- 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.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: |

###### GRIDCREATOR

###### KARABACON

Instance id: | HED_RR_SYS/MDL/KARABACON
Class id: | Karabacon
Host: | hed-rr-sys-con-4
Class documentation:
| Karabacon
Alias: | hed-rr-sys-con-4
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: | HED_RR_SYS/MDL/KARABACON|MainControl, HED_RR_SYS/MDL/KARABACON|Plot, HED_RR_SYS/MDL/KARABACON_scene_old, HED_RR_SYS/MDL/KARABACON|MainControl, HED_RR_SYS/MDL/NORMALIZER|Main, Normalizer_simple, SCANSCENE, HED_RR_SYS/MDL/KARABACON_wide_old, HED_RR_SYS/MDL/KARABACON|scene, main, ScanSample_XYZ_from2586, ScanSample_fixedZ, HED_RR_SYS/MDL/KARABACON|scene, HED_RR_SYS/MDL/KARABACON|plot, HED_RR_SYS/MDL/KARABACON|norm, HED_RR_SYS/MDL/KARABACON|norm, HED_RR_SYS/MDL/KARABACON|plot, HED_RR_SYS/MDL/KARABACON|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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 scantool should be used without XFEL DAQ, set tofalse. Can only be set before instantiation.
- 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

###### NORMALIZER

Instance id: | HED_RR_SYS/MDL/NORMALIZER
Host: | exflcon168
Alias: | hed-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/scantoolManipulator
Last modified: | 2019-09-04T12:23:00.000+02:00
Created at: | 2019-05-24T13:57:07.000+02:00
Main authors: | Schaffer
Latest tag: | 0.2.2-2.6.1
Deployment tag: | 0.2.2-2.6.1
Installed tag: | 0.2.2-2.6.1
Scenes: | HED_RR_SYS/MDL/NORMALIZER|Main, Normalizer_simple, Normalizer_source_selection
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

###### TRIGGER

Instance id: | HED_RR_SYS/MDL/TRIGGER
Class id: | SimulatedTrigger
Host: | hed-rr-sys-con-4
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/simulatedTrigger
Last modified: | 2021-05-25T11:57:57.000+02:00
Created at: | 2017-11-09T17:34:21.000+01:00
Main authors: | Danilevski, Xctrl, Degon
Latest tag: | 1.1.1-2.10.4
Deployment tag: | 1.1.1-2.10.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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
- interfaces:
    Describes the interfaces for this device
- acquisitionTime:
    The triggers stays this long in ACQUIRING state

Release History
1.1.1-2.10.4

Created: | 2021-05-25T12:07:21.000+02:00
Author: | Gero Flucke
Notes: |

1.1.0-2.10.0

Created: | 2020-11-19T15:36:43.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.3.0

Created: | 2018-11-21T18:01:59.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.2

Created: | 2018-03-02T15:17:19.000+01:00
Author: | Dennis Goeries
Notes: |

###### SCANPROC

Instance id: | HED_RR_SYS/MDL/SCANPROC
Host: | exflcon177
Alias: | hed-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/scantoolprocessor
Last modified: | 2020-03-11T20:00:27.000+01:00
Created at: | 2019-12-19T13:08:19.000+01:00
Main authors: | Mohacsi
Latest tag: | None
Deployment tag: | None
Installed tag: | None
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

[add instance documentation]

Release History

###### PPU_STROBE

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### TESTMOTOR

##### PLC

###### 1

Instance id: | HED_RR_SYS/PLC/1
Class id: | BeckhoffCom
Host: | hed-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-16 , hed-rr-sys-con-14 , hed-rr-sys-con-10 , hed-rr-sys-con-15 , hed-rr-sys-con-12 , hed-rr-sys-con-11 , hed-rr-sys-con-1 , hed-rr-sys-con-18 , hed-rr-sys-con-17 , hed-rr-sys-con-13
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: | TrainID_overview, TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

Instance id: | HED_RR_SYS/PLC/10
Class id: | BeckhoffCom
Host: | hed-rr-sys-con-8
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TrainID_overview, TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_RR_SYS/PLC/10_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TrainID_overview, TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_RR_SYS/PLC/11
Class id: | BeckhoffCom
Host: | hed-rr-sys-con-8
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_RR_SYS/PLC/11_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | hed-rr-sys-con-8
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-8
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: | TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: | HED_RR_SYS/PLC/12
Class id: | BeckhoffCom
Host: | hed-rr-sys-con-9
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | TrainID_overview, TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### 13

Instance id: | HED_RR_SYS/PLC/13
Class id: | BeckhoffCom
Host: | hed-rr-sys-con-9
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | hed-rr-sys-con-9
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: | TrainID_overview, TrainID_overview_HED, PLCsStateOverview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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 an